python命名规范

平常写代码杂乱无章的,自己看上去没太大影响,但是当别人来读你的代码的时候就苦不堪言,自己再去整理的时候很多问题也难以发现,代码过程中也是东一块西一块像是拼接成似的,所以这个时候规范化的代码就显得格外重要,小编在实验室的练习过程中就发现,与学校合作的公司项目要求都是在项目命名格外注重的。

  • 项目名——首字母大写、其余单词小写,多单词组合则用下划线分割
  • 包名、模块名——全用小写字母
  • 类名——首字母大写、其他字母小写,多单词采用驼峰
  • 方法——小写单词
  • 函数——若函数的参数名与保留关键字冲突,则在参数后加一个下划线,比拼音好太多
  • 全局变量——采用全大写,多单词用下划线分割

注意:

1.不论是类成员变量还是全局变量,均不使用 m 或 g 前缀。
2.私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。
3.变量名不应带有类型信息,因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。
4.开头,结尾,一般为python的自有变量,不要以这种方式命名
5.以__开头(2个下划线),是私有实例变量(外部不嫩直接访问),依照情况进行命名

缩写

命名应当尽量使用全拼写的单词,缩写的情况有如下两种:

  1. 常用的缩写,如XML、ID等,在命名时也应只大写首字母,如XmlParser。
  2. 命名中含有长单词,对某个单词进行缩写。这时应使用约定成俗的缩写方式。

例如:

function 缩写为 fn
text 缩写为 txt
object 缩写为 obj
count 缩写为 cnt
number 缩写为 num,等。

前导后缀下划线

一个前导下划线:表示非公有。
一个后缀下划线:避免关键字冲突。
两个前导下划线:当命名一个类属性引起名称冲突时使用。
两个前导和后缀下划线:(有特殊用图)的对象或者属性,例如init或者file。绝对不要创造这样的名字,而只是使用它们。
注意——关于下划线的使用存在一些争议。

命名注意:

不要使用小写字母'l'(el),大写字母'O'(oh),或者小写'i'作为单独变量名称。因为一些字体中,上诉字母和数字很难区分(比如:O和0,l和1)。

  • 参考自python学习笔记

你可能感兴趣的:(python命名规范)