Original Note
Coding Conventions - Outline
Outline
- Coding Conventions
- 正文
- Indentation
- 悬挂缩进
- 函数定义也是同样道理
- Maximum Line Length
- Blank lines
- 1. 顶层函数和类之间空两行
- 2. 类中的方法之间空一行
- 3. 函数内部可以少量使用空行
- 4. 装饰器与定义之间不要空行
- White spaces
- 1. 括号内部不要加无意义空格
- 2. 逗号、分号、冒号前不留空格
- 3. 切片中的冒号是特殊情况
- 8. 二元运算符两侧通常各一个空格
- 赋值运算符
- 增强赋值
- 比较运算符
- 成员运算符
- 身份运算符
- 布尔运算符
- 9. 普通赋值中的 `=` 两侧有空格
- 10. 关键字参数中的 `=` 两侧不加空格
- 11. 无类型注解的默认参数也不加空格
- Naming Conventions
- 不同对象的推荐命名
- 变量:snake_case
- 函数:snake_case,并使用动词
- 类:PascalCase,并使用名词
- 模块:简短、全小写
- 包:简短、全小写,尽量不用下划线
- 实践中的推荐规则
- Comments
- Block comment:块注释
- Inline comment:行内注释
- DocString
- Google 风格