Python注释之多行注释和单行注释使用及说明

前言

在编写 Python 代码时，注释（Comments）是一个非常重要的元素。它就像是代码中的小帮手，用来向用户提示或解释某些代码的作用和功能。注释可以出现在代码中的任何位置，而且 Python 解释器在执行代码时会自动忽略注释，就好像它根本不存在一样，不会对代码的实际运行产生任何影响。

在调试（Debug）程序的过程中，注释还能发挥特别的作用。有时候我们可能会遇到一些暂时不需要执行的代码，或者觉得某些代码可能存在问题，这时候就可以通过注释把这些代码“隐藏”起来，让 Python 解释器不去处理它们。

注释最大的好处就是能够提高程序的可读性。想象一下，如果一段代码没有任何注释，对于其他人，甚至是过了一段时间后的自己来说，就像一本看不懂的天书，会让人感到非常头疼！所以，千万不要觉得自己写的代码规范，就可以不加注释。把没有注释的代码交给别人，其实是对别人的不尊重，是一种很自私的行为哦。很多程序员宁愿自己去开发一个新的应用，也不愿意去修改别人没有合理注释的代码，这是因为没有注释的代码实在是太难理解了。虽然良好的代码本身也可以有一定的可读性，但我们永远不知道今后阅读这段代码的人是谁，他是不是和我们有一样的思路；而且，时间久了，我们自己可能也会忘记当时写这段代码的目的。

一般来说，合理的代码注释应该占到源代码的三分之一左右，这样可以让代码更加清晰易懂。

Python 支持两种类型的注释，分别是单行注释和多行注释。

下面我们就来详细了解一下这两种注释的使用方法。

Python 单行注释

在 Python 中，我们使用井号#作为单行注释的符号。

它的语法格式非常简单，就是在#后面加上你想要注释的内容，如下所示：

# 注释内容

只要 Python 解释器遇到#，就会忽略从#开始一直到这行结束的所有内容。也就是说，这一行后面的所有文字都不会被 Python 解释器执行，而是作为注释存在。

当我们要说明多行代码的功能时，一般会把注释放在代码的上一行。

比如下面这段代码：

# 使用print输出字符串
print("Hello World!")
print("C语言中文网")
print("http://c.biancheng.net/python/")
# 使用 print输出数字
print(100)
print( 3 + 100 * 2)
print( (3 + 100) * 2 )

在这个例子中，“# 使用print输出字符串”这个注释就说明了下面三行代码的作用，“# 使用 print输出数字”则说明了后面三行代码的作用。

而当我们要说明单行代码的功能时，通常会把注释放在代码的右侧。像这样：

print("http://c.biancheng.net/python/")  #输出Python教程的地址
print( 36.7 * 14.5 )  #输出乘积
print( 100 % 7 )  #输出余数

在这些代码中，右侧的注释清晰地说明了每一行代码的具体功能。

Python 多行注释

多行注释，顾名思义，就是可以一次性注释程序中多行的内容，当然也包括只注释一行的情况。

在 Python 中，我们使用三个连续的单引号’''或者三个连续的双引号"""来注释多行内容。

具体格式如下：

'''
使用 3 个单引号分别作为注释的开头和结尾
可以一次性注释多行内容
这里面的内容全部是注释内容
'''

或者

"""
使用 3 个双引号分别作为注释的开头和结尾
可以一次性注释多行内容
这里面的内容全部是注释内容
"""

多行注释通常会被用来为 Python 文件、模块、类或者函数等添加版权或者功能描述信息。比如说，我们写了一个函数，就可以在函数的开头使用多行注释来描述这个函数的作用、输入参数和返回值等信息，这样其他人在使用这个函数的时候就能很清楚地知道它的功能了。

注意事项

Python多行注释是不支持嵌套的哦

也就是说，下面这样的写法是错误的：

'''
外层注释
    '''
    内层注释
    '''
'''

因为 Python 解释器没办法正确识别这种嵌套的注释结构，可能会导致代码出现错误。

不管是多行注释还是单行注释

当注释符作为字符串的一部分出现时，就不能再把它们视为注释标记了，而应该把它们看作正常代码的一部分。

比如下面这段代码：

print('''Hello,World!''')
print("""http://c.biancheng.net/cplus/""")
print("#是单行注释的开始")

运行这段代码后，我们会得到以下结果：

Hello,World!
http://c.biancheng.net/cplus/
#是单行注释的开始

对于前两行代码，Python 没有把这里的三个引号看作是多行注释，而是把它们当成了字符串的开始和结束标志。对于第 3 行代码，Python 也没有把井号看作单行注释，而是把它当成了字符串的一部分。所以，我们在写代码的时候一定要注意这一点，避免因为混淆而导致错误。

注释可以帮助调试程序

给代码添加说明是注释最基本的作用，除此之外，它还有一个非常实用的功能，那就是用来调试程序。

比如说，当我们在编写程序的时候，发现程序运行结果不对，怀疑某段代码可能有问题。这时候，我们可以先把这段代码注释起来，也就是用注释符号把它变成注释内容，让 Python 解释器忽略这段代码，然后再运行程序。如果程序可以正常执行了，那就说明错误很可能就是由这段被注释的代码引起的；反之，如果程序依然出现相同的错误，那就说明错误不是由这段代码引起的，我们就需要继续检查其他代码。

通过在调试程序的过程中使用注释，我们可以逐步缩小错误所在的范围，快速找到问题的根源，大大提高调试程序的效率。所以，在编程过程中，合理使用注释不仅能让代码更易读，还能帮助我们更快地解决问题哦。

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

最新评论