Python-简明命名规范

分享一个大牛的人工智能教程。零基础!通俗易懂!风趣幽默!希望你也加入到人工智能的队伍中来!请点击http://www.captainbed.net

包(目录)

应该是简短的、小写的名字。最好不要使用下划线。

模块(文件)

应该是简短的、小写的名字。如果下划线可以改善可读性可以加入。

总是使用首字母大写单词串,如MyClass。内部类可以使用额外的前导下划线。

函数和方法

函数名应该为小写,可以用下划线以增加可读性。如:my_function。

函数和方法的参数

总使用“self”作为实例方法的第一个参数。总使用“cls”作为类方法的第一个参数。
如果一个函数的参数名称和保留的关键字冲突,通常使用一个后缀下划线好于使用缩写或奇怪的拼写。

变量

变量名全部小写,由下划线连接各个单词。如my_variable。

1、不论是类成员变量还是全局变量,均不使用 m 或 g 前缀。
2、私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。
3、变量名不应带有类型信息,因为Python是动态类型语言。

全局变量

变量名大写,由下划线连接各个单词,如:GLOBAL_VAR_NAME。

常量

常量名所有字母大写,由下划线连接各个单词,如:MAX_SIZE。

异常

以“Error”作为后缀。

缩写

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

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

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

前导后缀下划线
一个前导下划线:表示非公有。
一个后缀下划线:避免关键字冲突。
两个前导下划线:当命名一个类属性引起名称冲突时使用。
两个前导和后缀下划线:“magic”(有特殊用途)对象或者属性,例如__init__或者__file__。建议不要创造这样的名字,而只是使用它们。

猜你喜欢

转载自blog.csdn.net/chimomo/article/details/109776429
今日推荐