您的位置:首页 > 编程语言 > Python开发

Python注释

2014-01-04 17:29 197 查看

单行注释

python中单行注释采用 #开头
print ‘hello python’

#this is a comment



多行注释

然后python蛋疼的没有块注释,所以现在推荐的多行注释也是采用的 #比如:
# comments start
#content
#comments end
不过这种风格和标准的Java注释很像
/**
*java注释
*/
网上说的什么使用”"” if 0:我个人觉得很不好。。。google python style 中也是采用的#来进行多行注释

代码间注释

这个就直接引用一段 google 的编程规范原文吧



意思就是 不要去刻意对齐注释,后期维护代码会增加麻烦

特殊注释

比如#! /usr/bin/python 这句注释的意思就是告诉LINUX/UNIX去找到python的翻译器,大部分文件都不需要这个,只在要求也执行的文件中添加。
关于蛋疼的中文编码: # coding = utf-8 【注:这句代码蛋疼的必须放在第二行啊,而且多个空格都不行啊!】

Python的福利!!

Python在注释中有一个非常有用的东西是 doc String ,它可以用于模块、函数和类的描述:(其实总结起来都是类)下面是一个标准的方法注释



用 """三个引号标识,第一行大写开头,作简要概述,句号结尾,空一行开始详细的描述。他的好处是 这些注释保存在方法的__doc__属性中,可以打印显示。这个其实和java 的doc也很相似,还记得大明湖畔的@吗。



作者:leeon
出处:http://www.cnblogs.com/octobershiner/
本文版权归作者和博客园共有,欢迎转载,但未经作者同意必须保留此段声明,否则保留追究法律责任的权利.

原文地址:点击打开链接
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: