Python编程规范:
① 代码布局
(1)缩进。标准Python风格中每个缩进级别使用4个空格,不推荐使用Tab,禁止混用空格与Tab。
(2)行的最大长度。每行最大长度为79,换行可以使用反斜杠,但建议使用圆括号。
(3)空白行。顶层函数和定义的类之间空两行,类中的方法定义之间空一行;函数内逻辑无关的代码段之间空一行,其他地方尽量不要空行。
② 空格的使用
(1)左括号前不要加空格。
(2)逗号、冒号、分号前不要加空格。
(3)函数和序列的左括号前不要加空格。
(4)操作符左右各加一个空格,如a + b = c。
(5)不要将多条语句写在同一行。
(6)if、for、while语句中,即使执行语句只有一行,也必须另起一行。
③ 代码注释
(1)块注释。块注释跟随被注释的代码,缩进至与代码相同的级别。块注释使用”#”开头。
(2)行内注释。行内注释是与代码语句同行的注释。行内注释与代码至少由两个空格分隔,注释以”#”开头。
(3)文档字符串。文档字符串指的是为所有公共模块、函数、类以及方法编写的文档说明。文档字符串使用三引号包裹。
④ 命名规范
(1)不要使用字母“l”、“O”、“I”作为单字符变量名。
(2)模块名、包名应简短且全为小写。
(3)函数名应该小写,如果想提高可读性,可以使用下划线分隔小写单词。
(4)类名首字母一般使用大写。
(5)常量通常采用全大写命名。如:PI。
⑤ 变量
(1)由字母、数字和下划线组成,且不以数字开头。
(2)区分大小写。
(3)通俗易懂,见名知意。
(4)如果由两个及以上单词组成,之间使用下划线连接。