Python代码书写规范简介

Python代码书写规范简介

编程规范，也称为编码约定是指在软件开发中遵循的规范和准则，是一组规定和指导，旨在规范和统一代码的编写风格、格式和命名习惯。编写符合规范的代码可以提高可读性、可维护性和可扩展性。编程规范不是硬性规定，而是一种指导性的规范和准则。

编程规范可以在项目的早期就明确定义，并通过团队共识和代码审查来保证每位开发人员都遵守，使得代码风格统一，相互理解和修改代码会更加容易，易于理解、维护和协作。通过遵循编程规范，可以提高代码的可读性、可维护性、安全性和性能，并加强团队合作效率。

Python编程规范应遵循 PEP 8。PEP是Python Enhancement Proposal的缩写，通常翻译为“Python增强提案”。每个PEP都是一份为Python社区提供的指导Python往更好的方向发展的技术文档，其中的第8号增强提案，是针对Python语言编订的代码风格指南：PEP 8 – Style Guide for Python Code | peps.python.org

中文翻译 https://www.cnblogs.com/bymo/p/9567140.html#_label2_0

以下是PEP8规范的一些要点：

1. 缩进使用4个空格，避免使用tab（制表符），因为不同的编辑器可能会解释制表符的宽度不同。

2. 每行代码尽量不超过79个字符。

3. 顶层函数和类的定义，前后用两个空行隔开，类里面的方法定义用一个空行隔开。

4. 在操作符前后加上空格，如赋值、比较、逻辑运算等。

5. 变量名、函数名应该小写，用下划线分隔单词，变量名也应该小写，如，my_variable。

6. 常量名应该全部大写，用下划线分隔单词，例如WEEK_OF_MONTH。

7. 类名采用驼峰式命名（Pascal命名），即每个单词首字母大写，不用下划线分隔，如如SpringBoot。

8. 在注释中使用英文，注释应该清晰明了，不要写无用的注释。

9. 避免使用单个字符的变量名，除非是计数器或迭代器。

10. 使用空格来分隔参数和参数列表，但是不要在函数名和左括号之间加空格。

11. 在代码中尽可能使用单引号，而不是双引号，除非字符串中包含单引号。

12. 导入模块时，应该将标准库模块放在其他模块之前，每个模块之间应该用一个空行分隔。每个导入模块语句应独占一行。

13. 对于模块、类和函数，使用文档字符串（docstring）来提供对其功能、参数、返回值等的说明。文档字符串应该位于定义的下方，并采用三重引号的形式。