Python 注释：如何正确使用注释提高代码可读性

Python–注释

一、Python中注释的形式

1、单行注释：使用“#”符号注释

#print("Hello World!") 
#使用“#”符号可以注释程序，也可以注释文字

使用“#”符号时一次只能注释一行代码。

2、多行注释：使用一对三个英文单引号注释

'''
print("Hello World!") 
'''

'''
使用''' '''符号可以注释程序，也可以注释文字
'''

3、多行注释：使用一对三个英文双引号注释

"""
print("Hello World!") 
"""

"""
使用""" """符号可以注释程序，也可以注释文字
"""

二、Python中注释的作用

1、注释程序

当一些程序加上注释后，Python的解释器便不再将这些程序进行解释处理了。简单来说就是加了注释的程序计算机是不会执行的。

print("这个没有加注释")
#print("这个加了注释")

运行程序后，输出结果如下：

可以看到，加了“#”注释的语句没有运行。当程序中一些代码不想让它运行的时候，便可以加上注释。

2、注释对程序起到解释说明的作用

例1：使用单行注释对add函数进行解释说明

#这是一个实现两个数相加的函数
def add(a, b):
    return a + b

sum = add(1, 2)
print(sum)

例2：使用多行注释对add函数进行解释说明

'''
这是一个实现两个数相加的函数
'''
def add(a, b):
    return a + b

sum = add(1, 2)
print(sum)

作者：墨上烟雨