Python 基本编码规范参考 PEP 8,以下是一些常见的规范:

  1. 代码缩进使用4个空格,不要使用制表符。
  2. 每行代码不要超过79个字符。
  3. 类和函数的定义之间应该有两个空行,函数内的逻辑块之间应该用一个空行隔开。
  4. 模块、函数变量、方法等的命名应该符合约定,使用小写字母和下划线,避免使用单个字符,避免使用双下划线开头和结尾。
  5. 在运算符前后加空格,但在括号内部不需要加空格。
  6. 注释应该清晰、简洁、准确,解释代码的意图和操作,而不是代码如何工作。
  7. 尽量使用内置函数和标准库模块,避免使用复杂的表达式和语法,保持代码简洁易读。
  8. 代码应该尽量遵循“DRY”原则,不要重复自己,使用函数和类封装重复的逻辑。
  9. 异常处理应该尽可能精细,避免捕获所有异常,只捕获需要处理的异常。
  10. 使用文档字符串来记录函数、类、模块的用法和参数,方便其他人使用和维护代码。

这些规范不仅可以使代码更易读、易懂,也能够提高代码的可维护性和可扩展性。

PEP 8

https://peps.python.org/pep-0008/