引言
注释的最大作用是提高程序的可读性,在开发过程中非常有必要加上注释。Python 支持两种类型的注释,分别是单行注释和多行注释。
1 单行注释
Python 使用井号#作为单行注释的符号,语法格式为:
# 注释内容
从井号(#)开始,直到这行结束为止的所有内容都是注释。Python 解释器遇到#时,会忽略它后面的整行内容。
说明多行代码的功能时一般将注释放在代码的上一行,例如:
# 使用print输出字符串
print("Good good study, day day up!")
print("好好学习,天天向上!")
说明单行代码的功能时一般将注释放在代码的右侧,例如:
print("架构师专栏") 输出公众号名称
print( 3 * 4 ) 输出乘积
print( 13 % 3 ) 输出余数
2 多行注释
多行注释指的是一次性注释程序中多行的内容(包含一行)。
Python 使用三个连续的单引号’''或者三个连续的双引号"""注释多行内容,具体格式如下:
'''
使用 3 个单引号分别作为注释的开头和结尾
可以一次性注释多行内容
这里面的内容全部是注释内容
'''
或者
"""
使用 3 个双引号分别作为注释的开头和结尾
可以一次性注释多行内容
这里面的内容全部是注释内容
"""
多行注释通常用来为 Python 文件、模块、类或者函数等添加版权或者功能描述信息。
3 注意事项
- Python 多行注释不支持嵌套,所以下面的写法是错误的:
'''
外层注释
'''
内层注释
'''
'''
- 不管是多行注释还是单行注释,当注释符作为字符串的一部分出现时,就不能再将它们视为注释标记,而应该看做正常代码的一部分,例如:
print('''Hello,World!''')
print("""微思研""")
print("#是单行注释的开始")
运行结果:
Hello,World!
微思研
#是单行注释的开始
对于前两行代码,Python 没有将这里的三个引号看作是多行注释,而是将它们看作字符串的开始和结束标志。
对于第3 行代码,Python 也没有将井号看作单行注释,而是将它看作字符串的一部分。
4 注释可以帮助调试程序
给代码添加说明是注释的基本作用,除此以外它还有另外一个实用的功能,就是用来调试程序。
举个例子,如果你觉得某段代码可能有问题,可以先把这段代码注释起来,让 Python 解释器忽略这段代码,然后再运行。如果程序可以正常执行,则可以说明错误就是由这段代码引起的;反之,如果依然出现相同的错误,则可以说明错误不是由这段代码引起的。
在调试程序的过程中使用注释可以缩小错误所在的范围,提高调试程序的效率。