Python基础：编码规范

Posted 2021-01-29 Libing@2019

1.命名规范

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

　　◊ 包名：全部小写字母，中间可以由点分隔开。作为命名空间，包名需具有唯一性。

　　◊ 模块名：全部小写字母，如果是多个单词构成，使用下划线分隔。

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

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

　　◊ 变量名：全部小写字母，如果由多个单词构成，使用下划线分隔。

　　　　　　   如果变量用于模块或函数内部，则变量名可以由下划线（_）开头。

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

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

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

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

　　◊ 常量名：全部大写字母，如果是由多个单词构成，可以使用下划线分隔。如YEAR、WEEK_OF_YEAR。

2.注释规范

2.1 文件注释

 

2.2 文档注释

 

2.3 代码注释

 

2.4 TODO注释