类型 | 命名规则 | 举例 |
---|---|---|
模块名/包名 | 全小写字母,简单有意义,如果需要可以使用下划线 | math、sys |
函数名 | 全小写字母,可以使用下划线增加可阅读性 | foo(), my_func() |
变量名 | 全小写字母,可以使用下划线增加可阅读性 | age、my_var |
类名 | 采用PascalCase命名规则,由多个单词组成名称,其每个单词的首字母大写 | MyClass |
常量名 | 全部大写字母,可以使用下划线增加可阅读性 | LEFT、TAX_RATE |
从另一篇文章参考过来的:
https://blog.csdn.net/MrLevo520/article/details/69155636
总体原则,新编代码必须按下面命名风格进行,现有库的编码尽量保持风格。绝不要单独使用例如大写的’i’和大写的’o’*
1.模块命名尽量短小,使用全部小写的方式,可以使用下划线。
2.包命名尽量短小,使用全部小写的方式,不可以使用下划线。
3.类的命名使用CapWords的方式,模块内部使用的类采用_CapWords的方式。
4.异常命名使用CapWords+Error后缀的方式。
5.全局变量尽量只在模块内有效,类似C语言中的static。实现方法有两种,一是all机制;二是前缀一个下划线。
6.函数命名使用全部小写的方式,可以使用下划线。
7.常量命名使用全部大写的方式,可以使用下划线。
8.类的属性(方法和变量)命名使用全部小写的方式,可以使用下划线。
9.类的属性有3种作用域public、non-public和subclass API,可以理解成C++中的public、private、protected,non-public属性前,前缀一条下划线。
10.类的属性若与关键字名字冲突,后缀一下划线,尽量不要使用缩略等其他方式。
11.为避免与子类属性命名冲突,在类的一些属性前,前缀两条下划线。比如:类Foo中声明__a,访问时,只能通过Foo._Foo__a,避免歧义。如果子类也叫Foo,那就无能为力了。
12.类的方法第一个参数必须是self,而静态方法第一个参数必须是cls。
网友评论