编写规则
-
每个import语句只导入一个模块,尽量避免一次导入多个模块。
-
不要在行尾添加分号“;”,也不要用分号将两条命令放在同一行。
-
建议每行不超过80个字符,如果超过,建议使用小括号“()”将多行内容隐式的连接起来,而不推荐使用反斜杠“\”进行连接。
str = ("我一直认为我是一直蜗牛。我一直爬,也许好没爬到金字塔的顶端。" "但是只要你在爬,就足以给自己留下令生命感动的日子。")
以下两种情况除外:
- 导入模块语句过长。
- 注释里的URL。
-
使用必要的空行可以增加代码的可读性。
命名规范
- 模块名尽量短小,,并且全部使用小写字母,可以使用下划线分割多个字母。
- 包名尽量短小,并且全部使用小写字母,不推荐使用下划线。
- 类名采用首字母大写形式。例如,定义一个借书类,可以命名为BorrowBook。
- 模块内部的类采用下划线“_"+Pascal风格的类名组成。例如,在BorrowBook类中的内部类,可以使用
- 函数、类的属性和方法的命名规则同模块类似,也是全部使用小写字母,多个字母间用下划线“_"分割。
- 常量命名时全部使用大写字母,可以使用下划线。
- 使用单下划线”_"开头的模块变量或者函数是受保护的,在使用from xxx import * 语句从模块中导入时这些变量或者函数不能被导入。
- 使用双下划线"__"开头的实例变量或方法是类私有的。