Python 代码规范整理（持续更新）

Python 代码规范整理

一、缩进

用 4 个空格作为缩进（不要使用Tab键）

  Tab 键是制表用的，不同编辑工具上，Tab 显示的长短不一样，但是空格在哪里都是一个空格！

二、注释

单行注释：

  1. 用井号
  2. 井号放在程序结尾右侧或上一行
  3. 注释和代码同行时，井号和代码之间应有至少 2 个空格
  4. 井号和注释之间应该至少有 1 个空格
  

多行注释（块注释）：

  1. 用一对连续的三个引号（单引号和双引号都可以）
  2. 放在代码上方
  3. 不支持嵌套（即不能在多行注释之中再加多行注释）

特殊注释：

  1. # coding:utf-8
  2. #！/usr/bin/env

  说明：1是定义 python 文件是以中文编码的格式作为编码字符集，以防止出现乱码问题。2的意思是去/usr/bin/env这个文件路径下找解释器来执行 python 文件。
  PS：

• 注释用来解释你的代码要做什么。
• 注释不是越多越好，一目了然的代码不需要注释。

参考资料

  1.https://blog.youkuaiyun.com/Gnewocean/article/details/85319590
  2.https://peps.python.org/pep-0008/
  3.https://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/
  4.https://blog.youkuaiyun.com/qq_25814297/article/details/124338183
  5.https://blog.youkuaiyun.com/weixin_38937840/article/details/126945839