Python注释规范：单行、多行注释写法与PEP8

脚本专家

Python 注释不会参与程序执行，它的作用是在代码中做标注说明，帮助自己和他人理解代码意图，从而增强可读性。围绕 Python 注释，常见的写法分为单行注释（行注释）和多行注释（块注释），实际项目中还要结合 PEP 8 等代码规范控制注释的位置和质量。

一、单行注释：以 # 开头

单行注释以 # 开头，# 右边的所有内容都会被视为说明文字，而不是真正执行的程序。示例：

2. # 这是第一个单行注释
3. print("hello python")

复制代码

为了保证可读性，# 后面建议先添加一个空格，再编写说明文字。

二、行尾注释：在代码后面增加单行注释

程序开发时，也可以使用 # 在代码后面或旁边增加说明文字。此时要注意，为了保证可读性，注释和代码之间至少要有两个空格。示例：

2. print("hello python")  # 输出 `hello python`

复制代码

这种写法适合对某一行代码做补充说明，尤其是变量、参数或输出结果不是一眼能看出含义的场景。

三、多行注释：使用三个连续引号

如果注释信息很多，一行无法显示，就可以使用多行注释。Python 中可以用一对连续的三个引号包裹多行内容，单引号和双引号都可以。示例：

2. """
3. 这是一个多行注释
4. 在多行注释之间，可以写很多很多的内容……
5. """
6. print("hello python")

复制代码

多行注释适合在代码块、复杂逻辑或需要集中说明的背景信息前使用。它不是越多越好，关键是把“为什么这样做”说明清楚。

四、什么时候需要使用注释

注释不是越多越好。对于一目了然的代码，不需要额外添加注释；对于复杂操作，应该在操作开始前写上若干行注释；对于不是一目了然的代码，可以在行尾添加注释，但为了可读性，行尾注释至少离开代码两个空格。

一个常见误区是用注释描述代码本身。更合适的做法是假设阅读代码的人比你更懂 Python，他只是不知道你的代码要做什么，因此注释应重点说明意图、原因和约束，而不是重复代码表面含义。

在一些正规的开发团队中，通常会有代码审核惯例，也就是团队中彼此阅读对方的代码。注释质量会直接影响代码审核和后续维护效率。

五、Python 代码规范与 PEP 8

Python 官方提供了一系列 PEP（Python Enhancement Proposals）文档，其中第 8 篇文档专门针对 Python 的代码格式给出建议，也就是俗称的 PEP 8。文档地址：https://www.python.org/dev/peps/pep-0008/ 。谷歌也有对应的中文文档：http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/ 。

无论使用哪种语言，编写出符合规范的代码，都是开始程序生涯的第一步。对 Python 来说，掌握单行注释、行尾注释与多行注释的写法，只是注释规范的一部分；更重要的是根据代码场景决定是否注释、注释在哪里、注释说明什么。

总结：单行注释用 #，行尾注释注意与代码至少隔两个空格；多行注释用一对连续三个引号；注释应服务于可读性和维护性，并参考 PEP 8 保持代码风格一致。