Python基础：编码规范（4）

1.命名规范

　　Python中不一样代码元素采用不一样命名方式：

　　◊ 包名：所有小写字母，中间能够由点分隔开。做为命名空间，包名需具备惟一性。

　　◊ 模块名：所有小写字母，若是是多个单词构成，使用下划线分隔。

　　◊ 类名：采用Pascal法命名，即每一个单词首字母大写。如：Student。

　　◊ 异常名：异常属于类，命名同类命名，但使用Error做为后缀。如：FileNotFoundError。

　　◊ 变量名：所有小写字母，若是由多个单词构成，使用下划线分隔。

　　　　　　   若是变量用于模块或函数内部，则变量名能够由下划线（_）开头。

　　　　　　   变量类内部私有变量名能够双下划线（__）开头。

　　　　　　   不要命名双下划线开头和结尾的变量，这是Python保留的。

　　　　　　   避免使用大写L、大写O和大写I做为变量名，不易阅读分辨。

　　◊ 函数名和方法名：同变量命名。

　　◊ 常量名：所有大写字母，若是是由多个单词构成，能够使用下划线分隔。如YEAR、WEEK_OF_YEAR。

2.注释规范

2.1 文件注释

 

2.2 文档注释

 

2.3 代码注释

 

2.4 TODO注释