最近觉得自己的代码很难阅读,所以查阅了一些python编码规范,打算给自己规定一套编码规则,便于以后查阅。
通常的编码规范如下:
常量
常量名所有字母大写,由下划线连接各个单词,如
WHITE = 0XFFFFFF
THIS_IS_A_CONSTANT = 1
变量
变量名全部小写,由下划线连接各个单词,如
color = WHITE
this_is_a_variable = 1
不论是类成员变量还是全局变量,均不使用 m 或 g 前缀。私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。
变量名不应带有类型信息,因为 Python 是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。
函数
函数名首字母小写,其余单词首字母大写。
类
类名单词首字母大写,不使用下划线连接单词。
模块
模块名全部小写,对于包内使用的模块,可以加一个下划线前缀,如
module.py
_internal_module.py
包
包的命名规范与模块相同。
考虑到区分开变量和函数,我自己规定的命名规范如下:
常量
所有字母大写,由下划线连接各个单词。eg. WHITE
变量
全部小写,由下划线连接各个单词。eg. this_is_var
函数
首字母小写,其余单词首字母大写,不使用下划线。eg. computerSum
类
单词首字母大写,不使用下划线。eg. ThisIsClass
模块
全部小写,不使用下划线。eg. module