确保对模块, 函数, 方法和行内注释使用正确的风格
Python中的注释有单行注释和多行注释:
一、Python中单行注释以 # 开头,例如:
# 这是一个注释
print("Hello, World!")
二、多行注释用三个单引号 ''' 或者三个双引号 """ 将注释括起来,例如:
1、单引号(''')
'''
这是多行注释,用三个单引号
这是多行注释,用三个单引号
这是多行注释,用三个单引号
'''
print("Hello, World!")
2、双引号(""")
"""
这是多行注释,用三个双引号
这是多行注释,用三个双引号
这是多行注释,用三个双引号
"""
print("Hello, World!")
文档注释的妙用
以下实例我们可以输出函数的注释:
def a():
'''这是文档字符串'''
pass
print(a.__doc__)
输出结果为:
这是文档字符串
注意:当函数中有语句的时候,是无法输出函数的注释的:
def a():
a=1
'''这是文档字符串'''
pass
print(a.__doc__)
输出结果为:None
以下这种方式可以,所以注释应该放在函数的第一行:
def a():
'''这是文档字符串'''
a = 1
pass
print(a.__doc__)
这是文档字符串