一文带你学会 Python 中的注释

前言

注释 就是对代码的解释和说明，通过注释能够让人们更加轻松地了解代码。有效的注释能够对程序中的语句、程序段、函数等进行解释或提示，从而提高程序代码的可读性。

注释介绍

Python 注释有单行注释和多行注释两种，单行注释使用#，多行注释可以使用 ''' 或 """。在 PyCharm 中，可以 Ctrl 和 / 键快速地进行单行注释。

1. 单行注释（行注释）

① 语法

单行注释只能注释一行内容，语法如下：

# 注释内容

② 示例代码

以下是单行注释的示例：

# 输出hello world
print('hello world')

print('hello Python')  # 输出 (简单的说明可以放到一行代码的后面，一般习惯代码后面添加两个空格再书写注释文字，便于自己和其它人了解代码的含义)

2. 多行注释

① 语法

单引号多行注释（块注释）

'''
	注释内容 1
	注释内容 2
	注释内容 3
'''

双引号多行注释（文档注释）

文档注释一般出现在模块头部、函数和类的头部。

"""
	注释内容 1
	注释内容 2
	注释内容 3
"""

② 示例代码

单引号多行注释

'''
	hello Python
	hello Python
	hello Python
'''

双引号多行注释

""
	The author is me.
	I'm in ...
"""

3. PyCharm 中的注释

在 PyCharm 中，可以使用 Ctrl + / 键来进行快速单行注释。

嵌套注释

Python中既支持嵌套注释，又不支持嵌套注释。怎么说？

① 同种类型的引号之间不能嵌套注释。

'''与'''之间不能嵌套注释，"""与"""之间也不能嵌套注释，就像下图一样会报错。

② 不同种类的引号之间可以嵌套注释。

'''与"""之间可以嵌套注释，两者位置没有区别。

"""
    '''
        Hello Python
    '''
"""



'''
    """
        Hello Python
    """
'''

③ 最多只能嵌套两层。

像下面这样反复套娃也是会报错的。

注意

1. 一般情况下，合理的代码注释应该占源代码的 1/3 左右。
2. 在代码重要的部分(或比较复杂的地方), 尽量多写注释。
3. 比较重要的注释段, 使用多个等号==或横线-隔开, 可以更加引入注目。
4. 文档注释尽可能不要中英文混用，尽量用简洁的语言表达出模块、方法等的作用。
5. 对于一些有错误的代码可以注释掉来来缩小错误范围，加快调试效率。