Contents
  1. 1. 单行注释
  2. 2. 多行注释
  3. 3. 代码间注释
  4. 4. 特殊注释
  5. 5. python的福利!!

【转】原创作品,允许转载。转载时请务必以超链接形式标明文章原始出处、作者信息和本声明,否则将追究法律责任。
http://www.cnblogs.com/octobershiner/archive/2012/12/04/2801670.html

单行注释

python中单行注释采用#开头

1
2
print 'hello python'
#this is a comment


多行注释

然后python蛋疼的没有块注释,所以现在推荐的多行注释也是采用的#比如:

1
2
3
# comments start
#content
#comments end

不过这种风格和标准的Java注释很像

1
2
3
4
5
/**
*java注释
*/

网上说的什么使用""" if 0:我个人觉得很不好。。。google python style 中也是采用的#来进行多行注释

代码间注释

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

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

特殊注释

比如#! /usr/bin/python这句注释的意思就是告诉LINUX/UNIX去找到python的翻译器,大部分文件都不需要这个,只在要求也执行的文件中添加。

关于蛋疼的中文编码:# coding = utf-8【注:这句代码蛋疼的必须放在第二行啊,而且多个空格都不行啊!】

python的福利!!

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

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

Contents
  1. 1. 单行注释
  2. 2. 多行注释
  3. 3. 代码间注释
  4. 4. 特殊注释
  5. 5. python的福利!!