【Python】——注释

一、注释的概念

注释是一种特殊的代码，它不会影响到程序的执行， 但是能够起到解释说明的作用，能够帮助程序猿理解程序代码的执行逻辑。

# 计算 4 个数字 67.5, 89.0, 12.9, 32.2 的方差
avg = (67.5 + 89.0 + 12.9 + 32.2) / 4
total = (67.5 - avg) ** 2 + (89.0 - avg) ** 2 + (12.9 - avg) ** 2 + (32.2 - avg) 
** 2
result = total / 3
print(result)

形如上述代码，如果没有注释，直接阅读，是不容易 get 到代码的含义是计算方差。但是通过加了一行注释解释一下, 就让人一目了然。

PS: 代码的第一目标是容易理解, 第二目标才是执行正确。写注释不光是为了方便别人来理解, 也是方便三个月之后的自己理解。

二、注释的语法

Python中有两种风格的注释。

1.注释行

使用 # 开头的行都是注释，# 开头的注释，一般是写在要注释的代码的上方，也有少数情况下是写在要注释代码的右侧的，很少会写在代码的下方。更不会写到代码的左侧。

# 这是一行注释.

2.文档字符串

使用三引号引起来的称为 "文档字符串", 也可以视为是一种注释。 

• 可以包含多行内容
• 一般放在文件/函数/类的开头
• """ 或者 ''' 均可 (等价)

"""
这是文档字符串
这是文档字符串
"""

3.批量注释代码

（1）批量选中代码

（2）Ctrl+/（批量取消注释也是这个操作）

三、注释的规范

1. 内容准确：注释内容要和代码一致、匹配，并在代码修改时及时更新。

2. 篇幅合理：注释既不应该太精简, 也不应该长篇大论。

3. 使用中文：一般中国公司都要求使用中文写注释, 外企另当别论。

4. 积极向上：注释中不要包含负能量。