代码编排
使用4空格缩进，不使用Tab,更不允许用Tab和空格混合缩进
每行最大长度最大79字节，超过部分使用反斜杠折行
类和全局函数定义间隔两个空行,类内方法定义间隔一个空行.其它地方可以不加空行。
文档编排
其中import部分，又按标准、三方和自己编写顺序依次排放，之间空一行。
不要在一句import中导入多个模块，比如不推荐import os, sys。
尽可能用import XX 而不采用from XX import YY引用库,因为可能出现名字冲突。
空格的使用
各种右括号前不用加空格
逗号、冒号、分号前不要加空格。
函数的左括号前不要加空格。如func(1)。
序列的左括号前不要加空格。如list[2]。
操作符左右各加一个空格，不要为了对齐增加空格。
函数默认参数使用的赋值符左右省略空格。
不要将多条语句写在同一行，尽管使用‘;’允许。
if/for/while语句中，即使执行语句只有一句，也必须另起一行
原则：避免不必要的空格
命名习惯
1.恒定量(常量)使用全大写与下划线:比如规定的不可更改的变量的值
2.私有变量使用前导下划线和小写,如:_message
3.一般的变量则应该:
全小写,用下划线隔开
表示类型的字母放在最前面
作用或要完成的工作则在中间
属于谁放在最后,或可省略
例如:
numpy_creat_data_set_test表示的意思是:
该变量是numpy类型,被创建为一个数据集,用于测试(test这个函数的内部变量)
4.当一个变量被用于保存于布尔值时,做好使用is或has作为前缀,这样更易于理解
5.当一个变量被用于保存序列时,最好使用复数形式
6.当一个变量被用于临时保存时,最好加上temp_的前缀
7.当一个变量被用于作为字典时,应该使用显示名称,如一个用来保存个人地址的变量:person_address
8.应当避免使用通用名称,现有名称(已有名称,变量i,j可以循环使用),
避免关键字,非得使用可以使用后缀下划线
9.类名使用驼峰命名法,当定义的是模块的私有类时,还可能有一个前导下划线
10.类内的名称必须简明,精确,并足以从中理解类所完成的工作.
常见的方法是表示其类型或特性的后缀:SQLEngine
11.对于基类而言,可以使用一个Base或Abstract前缀,如:BaseCookie
下面关于类中属性的命名规则:
12.属性名称是用小写或者小写加上下划线命名的.大部分时候,它们表示对象的状态,可以是一个名词或一个形容词,在需要的时候也可以是一个小短语
13.特殊方法是以两个下划线开始和结束的
14.应尝试避免类及其特性名称之间的冗余,如:STMP.smtp_send()存在冗余
作者：zzwwsun
来源：CSDN
原文：https://blog.csdn.net/weixin_41064957/article/details/80218121
版权声明：本文为博主原创文章，转载请附上博文链接！
网友评论