PEP 8 是 Python 社区的一套编码规范，旨在提高代码的可读性和一致性。

1. 文件和行

  • 文件名使用小写字母和下划线，例如 my_module.py。
  • 每行代码不超过 79 个字符。
  • 每个文件的开头和结尾各添加两个空行。

2. 注释

  • 使用英文进行注释。
  • 单行注释前加 #。
  • 多行注释使用三个双引号 """ 或三个单引号 '''。

3. 类和函数

  • 类名使用大驼峰式命名（CamelCase），例如 MyClass。
  • 函数名使用小写字母和下划线，例如 my_function。
  • 每个函数和类定义后添加两个空行。

4. 代码块

  • 使用四个空格缩进代码块。
  • 每个缩进层级增加四个空格。

5. 引用

  • 使用英文进行引用。
  • 引用文本使用反引号 包围。

6. 代码风格

  • 使用 def 关键字定义函数。
  • 使用 class 关键字定义类。
  • 使用 if, else, for, while 等关键字进行条件判断和循环。

扩展阅读

Python Logo