requirements.md

缩进、空行规则：

• 缩进4个空格的缩进（编辑器都可以完成此功能），不要使用Tap，更不能混合使用Tap和空格。类和top-level函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行

命名规则：

总体原则，新编代码必须按下面命名风格进行，现有库的编码尽量保持风格。

• 尽量单独使用小写字母‘l'，大写字母‘O'等容易混淆的字母。
• 模块命名尽量短小，使用全部小写的方式，可以使用下划线。
• 包命名尽量短小，使用全部小写的方式，不可以使用下划线。
• 类的命名使用CapWords的方式，模块内部使用的类采用_CapWords的方式。
• 异常命名使用CapWords+Error后缀的方式。
• 全局变量尽量只在模块内有效，类似C语言中的static。实现方法有两种，一是__all__机制;二是前缀一个下划线。
• 函数命名使用全部小写的方式，可以使用下划线。
• 常量命名使用全部大写的方式，可以使用下划线。
• 类的属性（方法和变量）命名使用全部小写的方式，可以使用下划线。
• 类的属性有3种作用域public、non-public和subclass API，可以理解成C++中的public、private、protected，non-public属性前，前缀一条下划线。
• 类的属性若与关键字名字冲突，后缀一下划线，尽量不要使用缩略等其他方式。
• 为避免与子类属性命名冲突，在类的一些属性前，前缀两条下划线。
• 类的方法第一个参数必须是self，而静态方法第一个参数必须是cls。

每行最多字符数：

• 限制所有行最多100个字符。为了使较长的文本块具有较少的结构限制（文档字符串或注释），行长应限制为72个字符。换行可以使用反斜杠，最好使用圆括号。换行点要在操作符的后边敲回车。

注释

• 总体原则,错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是要修改注释！
• 注释必须使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。
• 块注释，在一段代码前增加的注释。在‘#'后加一空格。段落之间以只有‘#'的行间隔。
• 行注释，在一句代码后加注释。比如：x = x + 1 # Incrementx 但是这种方式尽量少使用。
• 避免无谓的注释。

操作符前后空格：

• 二元运算符前后，都要加空格，但作为函数参数时＝前后不用加空格 如果使用具有不同优先级的运算符，只在具有最低优先级的运算符周围两边添加空格，其它的就不用加。