花费一点时间在代码中添加注释、文档字符串和类型提示可以避免将来浪费更多的时间——有着良好解释说明的代码更具可维护性。

程序员有时候会留下简短的注释，提醒自己还有哪些工作要做，通常是以代码标签的形式：以全大写字母标签开头，后面是简短描述的注释。理想情况下，你会使用项目管理工具来追踪这类问题，而不只是写在代码中。但对于没有使用这些工具的小型个人项目而言，少量的TODO注释可以起到提醒的作用。

TODO：提示需要完成的工作。

FIXME：提示这部分代码还不能正常工作。

HACK：提示这部分代码可以工作，但可能有些勉强，需要做出改进。

XXX：通常用于提示高度严重的问题

参考示例：

_chargeIonFluxStream() # TODO：排查为什么每周二都会失败

文档字符串是出现在模块的.py源代码文件顶部或者在类或def语句之后的多行注释。

它们提供关于被定义的模块、类、函数或方法的文档。自动文档生成工具可以使用这些文档字符串生成外部文档，比如帮助文档或网页。

文档字符串必须使用三引号的多行注释，不能使用以#开头的单行注释。

文档字符串应该始终使用3个双引号，而非3个单引号进行包裹。