跳转至

Topic 2.6 - Python 代码规范 (补充)

在团队开发或长期维护中,良好的代码规范比单纯写出能跑的代码更重要。

  • 因为代码不仅仅是给计算机看的,也是给人看的
  • 代码写得好看,既能保证别人能看懂你的代码,也能保证自己以后能看得懂自己的代码

Python 官方提供了一份代码风格指南:Python Enhancement Proposal 8 (PEP 8): https://peps.python.org/pep-0008/

常见的语法规范有以下一些,有些我们已经见到过了,有些我们会在后续课程中提到:

  • 行宽:每行代码不超过 79 个字符,注释行不超过 72 个字符
  • 缩进:使用 4 个空格进行缩进,不使用 Tab 键
  • 空行:函数和类定义之间使用两个空行,方法定义之间使用一个空行
  • 命名规范

  • 变量名、函数名使用小写字母和下划线(snake_case)

  • 类名使用首字母大写的单词(PascalCase)
  • 常量名使用全部大写字母和下划线(UPPER_SNAKE_CASE)

  • 空格使用

  • 在逗号、分号、冒号后面添加一个空格

  • 在函数参数列表的括号内侧不添加空格
  • 在二元运算符(如 =, +, -, == 等)两侧添加一个空格

  • 注释:使用完整的句子,首字母大写,句末加句号。注释应与代码保持一致,避免过时的注释

  • 导入顺序:所有库的导入在文件开头完成,且标准库导入、第三方库导入、本地应用/库导入,之间用空行分隔