注释的作用

• 提高代码可读性
• 提升开发效率

什么时候使用注释？

• 容易看懂的代码不需要注释
• 对于复杂的代码，在操作前写上思路
• 对于一目了然的代码，在其行尾添加注释
• 绝不要描述代码，阅读代码的人可能更比你懂代码

注释类型

单行注释

• 以 # 开头，# 右边的所有东西都被当作说明文字，而不是真正要执行的程序，为了保证代码的可读性，注释和代码之间至少要有两个空格。

多行注释

• 一对连续的三引号（单引号或双引号）

文档注释

• 文档注释是包、模块、类或函数里的第一个语句。这些注释可以通过对象的doc成员被自动提取，并且被pydoc所用。文档注释使用三重双引号（PEP-257）。

模块

• 每个文件应该都包含一个许可样版，根据项目使用的许可选择合适的样版。

函数和方法

• 一个函数必须要有文档字符串，除非它满足以下条件：外部不可见、非常短小、简单明了。
• 注释应该包含用法、功能。
• 注释单行超过80字符，使用2或4个空格悬挂缩进。

类

• 类应该在其定义下有一个用于描述该类的文档字符串。