简明python代码规范.doc

业界普遍认同Python的注释分为两种的概念，一种是由#开头的“真正的”注释，另一种是docstrings。前者表明为何选择当前实现以及这种实现的原理和难点，后者表明如何使用这个包、模块、类、函数（方法），甚至包括使用示例和单元测试。 坚持适当注释原则。对不存在技术难点的代码坚持不注释，对存在技术难点的代码必须注释。但与注释不同，推荐对每一个包、模块、类、函数（方法）写docstrings，除非代码一目了然，非常简单。