软件工程之高质量代码（编码规范）

软件工程之高质量代码（编码规范）

软件工程之高质量代码（编码规范）

软件编码规范是与特定语言相关的描写如何编写代码的规则集合。
编码规范的目的 是提高编码质量，避免不必要的程序错误，增强程序代码的可读性、可重用性和可移植性。

Python的注释规范
形式1：由 # 开头的“真正的”注释，说明选择当前实现的原因以及这种实现的原理和难点；
形式2：文档字符串，说明如何使用包、模块、类、函数（方法），甚至包括使用示例和单元测试。

命名规范
要编写需要外部文档支持的代码，这样的代码是脆弱的，要确保你的代码本身读起来就很清晰。

语句规范

不要在行尾加分号 
类名应为驼峰风格且首字母大写，
变量名应为下划线风格
使用文件时应注意显式地调用close()，或使用with
每行只写一条语句
import 语句应遵循的原则： 
• import 次序：先 import Python 内置模块，再 import 第三方模块，最后 import 自己开发的项目中的其它模块；这几种模块中用空行分隔开来。 • 一条 import 语句 import 一个模块。 
• 当从模块中 import 多个对象且超过一行时，使用如下断行法（py2.5以上版本）：  	
• 不要使用 from module import *，除非是 import 常量定义模块或其它你确保不会出现命名空间冲突的模块。

更多完整内容请参考Google Python Style Guide： http://google.github.io/styleguide/pyguide.html
同时里边含有其他语言的代码规范。
参考自学堂在线。