python_编程规范

Posted 2020-08-23

• 缩进

    4个“空格”作为一个缩进层次，永远不要使用“制表位”

• 空格

    运算符两边放置一个空格

• 命名

　　　　 模块名：模块应该是不含下画线的、简短的、小写的名字。

　　　　 类名：几乎没有例外，类名总是使用首字母大写单词串（CapWords）的约定。

全局变量名：一般全部大写字母命名。

函式名：函式名应该为小写，可用下画线风格单词以增加可读性。

方法名和实例变量：这大体上和函式相同，通常使用小写单词，必要时用下画线分隔增加可读性

私有属性：必须有两个前导下画线，无后置下画线

• 文档化

为所有公共模块、函式、类和方法编写文档字符串。多行文档字符串结尾的""" 应该单独成行，对单行的文档字符串，结尾的"""在同一行也可以。