python注释规范

确保对模昌宽信块, 函数, 方法和行内注释使用正耐轮确的风格

参考：Python风格规范 — Google 开源项目风格指南

文档字符串

模块

函数和方法

Args :

Returns: (或者 Yields: 用于生成器)

Raises:

类巧蔽

块注释和行注释

多行注释指的是一次性注释程序中多行的内容。

Python使用三个连续的单引号'''或者三个连续的双引号"""注释多行内容，具体格式如下：

'''

使用3个单引号分别作为注释的开头和结尾

可以一次性注释多行内容

这里面的内容全部都是注释内容

'''

或者

"""

使用3个单引号分别作为注释的迟者开头和结尾

可以一次性注释多行内容

这里面的内容全部都是注释内容

"""

多行注释通常用来为Python文件、模块、类或者函数等添加版权或者功能描述信息。

注意事项

①Python多行注释不支持嵌套，所以下面的写法是错误的：

'''

外层注释

'''

内层注释

'''

'''

2、不管是多行注释还是单行注释，当注释符作为字符串的一部分出现时，就不能再将它们视为注释标记，而应该看做正常代码的一部分，闭让例如：

print('''hello,world!''')

print("""www.oldboyedu.com""")

print("#是单行注释的开始")

运行结果：

Hello,world!

www.oldboyedu.com

#是单行注释的开始

对于前两行代码，Python没有将这里的三轿旦局个引号看作是多行注释，而是将它们看作字符串的开始和结束标志。

对于第3行代码，Python也没有将井号看作单行注释，而是将它看作字符串的一部分。

---