python注释:让更多的人读懂你的代码

在python中单行注释使用#,#后直到行尾的内容会被忽略，不会被python解释器执行。

在python中多行注释使用一对三引号”’ ”’/””” “””（英文状态下），三引号之间的所有内容都会被忽略，不会被python解释器执行。

注释这些内容：

整体架构，高层次的观点。

函数的用法。

重要的解决方案，特别是在不是很明显时。

避免注释：

描述“代码如何工作”和“代码做了什么”。

避免在代码已经足够简单或代码有很好的自描述性而不需要注释的情况下，还写些没必要的注释。