Skip to content

Latest commit

 

History

History
58 lines (27 loc) · 1.38 KB

codestyle.md

File metadata and controls

58 lines (27 loc) · 1.38 KB

代码风格

  1. ###缩进

    • 每个缩进级别使用4个空格。
  2. ###变量命名

    • 变量名称应小写,必要时用下划线分隔单词,以提高可读性。

    • 仅在已经是主流样式(例如threading.py)的上下文中才允许使用mixedCase,以保持向后兼容性。

  3. ###每行最多字符数

    • 限制所有行最多79个字符。
  4. ###函数最大行数

    • 除一些定义外,函数的具体执行语句一般不超过20行。
  5. ###函数、类命名

    • 变量名称应小写,必要时用下划线分隔单词,以提高可读性。

    • 类名为大写字母开头的驼峰命名法, 一般情况下只使用一个单词

  6. ###常量

    • 全大写字母加下划线分隔
  7. ###空行规则

    • 函数和类的定义:前后用两个空行隔开

    • 类的方法:前后用一个空行隔开

    • 相关的功能组可以用额外的一个空行隔开

  8. ###注释规则

  • 与代码矛盾的注释比没有注释更糟糕。当代码更改时,始终要始终使注释保持最新状态!

  • 行内注释:注释与代码之间至少两个空格, 注释以#和一个空格开始。

  1. ###操作符前后空格
  • 各种括号后, 逗号、冒号前, 函数参数括号前, 索引括号前不接空格

  • 逗号后接一个空格

  1. ###其他规则