遵循PEP 8的常见规范:
-
缩进:
- 使用4个空格来缩进代码块,而不是使用制表符。
-
命名规范:
- 变量名应该使用小写字母 ,单词之间用下划线
_
分隔(snake_case)。 - 类名应该使用驼峰命名法(CamelCase)。
- 常量应该全大写 ,单词之间用下划线
_
分隔。
- 变量名应该使用小写字母 ,单词之间用下划线
-
行长度限制:
- 每行代码不应超过79个字符,可以适当延长到约99个字符。
-
空行:
- 在函数和类定义之间应该有两个空行。
- 在函数内部不同逻辑块之间应该有一个空行。
-
导入规范:
- 导入应该放在文件顶部,每个导入应该独占一行。
- 推荐按照分组顺序导入:标准库、第三方库、自己编写的模块。
-
注释:
- 使用注释来解释代码的目的和思路,而不是描述代码做了什么。
- 注释应该清晰简洁,避免使用无意义的注释。
-
函数和方法:
- 函数和方法之间应该有两个空行。
- 函数的参数列表、返回值和冒号之间不应该有空格。
-
代码风格:
- 尽量避免一行代码过长,可以适当换行。
- 使用内置函数和方法,避免过度复杂化代码。
- 避免使用全局变量,尽量使用局部变量。