代码布局

使用PEP8(pip install pycodestyle)
1). 缩进统一使用4个空格

2). 行最大长度为79，没有代码块的注视行最大字符72

  • 有括号的换行，直接回车，以加号等计算符分割，将符号放在第二行并与第一行括号对其
  • 注释不超过72的使用 ’\‘进行换行，并与第一行的括号对其

3). 插入空行

  • 函数之间，倒入模块与函数之间

4). import模块

  • 推荐单行导入，import os, import sys,不要使用imort os, sys
  • from utils import request, parse这种例外
  • 倒入模块通常位于文档说明的下方，全局变量的上方。
  • 避免通配符的导入，可能会与已有命名空间的命名冲突，from numpy import *

5). 表达式和语句中的空格

  • 避免使用无关的空格：紧跟在小中大括号后、紧贴在逗号，分号，冒号前、紧贴在函数参数的左括号之前。
  • 函数中的默认参数或自定义中的等号无需空格，如encoding=‘utf-8’，step=5
  • 二元运算符两边各加一个空格，二元运算符包括（赋值，增量赋值+=，-=，比较，布尔）
  • 表达式和语句中的空格
    • i = i + 1
    • a += 1
    • c = (a+b) * (a-b)

命名规范

编码命名

  1. 使用英文单词命名，除非是习惯用的简拼，否则不要使用，
  2. 不要害怕过长的变量名。
  3. 避免重复使用变量名表示不同的对象
  4. 不能使用内建名称，使其在当前命名空间被屏蔽
  5. 避免使用o,0 ,I,1等易混淆
  6. 避免使用大小写区别对象
  7. 使用下划线分割小写单词提高可读性

命名约定

  1. Class命名，首字母大写
  2. Exception Names异常名：异常一般为类，异常名后面加Error后缀。
  3. 常量命名，通常使用全大写，或加下划线，MAX_OVERFLOW&TOTAL

有时候命名规范并一定严格执行，项目中和开发人员越好的命名也是可以使用的。

注释原则

  1. 与代码相矛盾的注释比没有还要糟糕，更改代码，就更改注释。
  2. 注释应该是完整的句子。如果是短语或句子，第一个单词大写
  3. 如果注释较短，结尾的句号可以省略。块注释一般由完整句子的一个或多个段落组成，并且每句话结束有个句号。
  4. 在句尾结束时候应该使用两个空格。
  5. 尽量使用英文写注释（除非特殊场景）

注释分类

  1. 块注释
  2. 行注释
  3. 文档注释

较长的写成块注释，行注释较短，不用全都写注释，对那些不能一目了然的函数进行注释，写明参数和返回值以及返回类型。

要求

不关你啥时候上厕所，重构的代码要保证去厕所的时候是可以运行的