团队编码规范.md

团队编码规范

极客点儿

2020-08-05

任何规范都是为了将团队的编码统一标准化。所以在不违背 PEP8 编码规范的前提下，为了团队开发效率和编程习惯，将一些规范简化、细化或扩展。

一、命名规范

1. 变量

• 小写字母和下划线命名

2. 常量

• 大写字母和下划线命名

3. 函数

• 小驼峰命名法

• 小写字母和下划线命名

4. 类名

• 大驼峰命名法

5. 属性

• 小写字母和下划线命名

• 以 _ 开头属于私有属性

6. 方法

• 小驼峰命名法

• 小写字母和下划线命名

• 以 _ 开头属于私有方法

7. 模块

• 统一以 .py 为后缀

• 小写字母和下划线命名

• 类名和类文件名保持一致

8. 包

• 目录下包含 __init__.py 模块

• 小写字母和下划线命名

9. 目录

• 小驼峰命名法

• 小写字母和下划线命名

10. 项目

• 点命名法

• 小驼峰命名法

• 小写字母和下划线命名

二、编码规范

1. 解释器

指定从 PATH 环境变量中来查找 Python 解释器的位置

#!/usr/bin/env python3

2. 编码

指定 UTF-8 编码

# -*- coding: UTF-8 -*-

3. 缩进

• 统一使用 4 个空格进行缩进

4. 空格

• 在二元运算符两边各空一格

• 函数的参数列表中，之后要有空格

• 函数的参数列表中，默认值等号两边不要添加空格

• 左括号之后，右括号之前不要加多余的空格

• 字典对象的左括号之前不要多余的空格

• 不要为对齐赋值语句而使用的额外空格

5. 换行

• 使用反斜杠 \ 换行

• 二元运算符 + 、 . 等应出现在行末

• 长字符串也可以用此法换行

6. 行宽

• 每行代码不超过 79 个字符

7. 引号

• 字符串使用单引号或双引号

• 机器标识使用单引号

• 正则表达式使用原生的双引号

• 文档字符串使用三个双引号

8. 空行

• 引入模块后空两行

• 模块级函数和类定义之间空两行

• 类成员函数之间空一行

• 可以使用多个空行分隔多组相关的函数

• 函数中可以使用空行分隔出逻辑相关的代码

9. import

• import 语句应该分行书写

10. 注释

• 块注释

  • # 后空一格

  • 段落用空行分开

• 行注释

  • 至少使用两个空格和语句分开

  • 不要使用无意义的注释

11. 文档字符串 (docstring)

• 所有的公共模块、函数、类、方法，都应该写 docstring

• 私有方法不一定需要，但应该在 def 后提供一个块注释来说明