Chapter11.Specification.md

11. 工程开发规范

由于工程开发规范不够统一，内容过于庞杂，此处所作研究仅为参考。

一些标准的开发规范

• PEP8编码规范

11.1. PEP8编码规范

11.1.1. 代码编排

1. 使用4空格缩进，不使用Tab,更不允许用Tab和空格混合缩进
2. 每行最大长度最大79字节，超过部分使用反斜杠折行
3. 类和全局函数定义间隔两个空行,类内方法定义间隔一个空行.其它地方可以不加空行。

11.1.2. 文档编排

1. 其中import部分，又按标准、三方和自己编写顺序依次排放，之间空一行。
2. 不要在一句import中导入多个模块，比如不推荐import os, sys。
3. 尽可能用import XX 而不采用from XX import YY引用库,因为可能出现名字冲突。

11.1.3. 空格的使用

1. 各种右括号前不用加空格
2. 逗号、冒号、分号前不要加空格。
3. 函数的左括号前不要加空格。如func(1)。
4. 序列的左括号前不要加空格。如list[2]。
5. 操作符左右各加一个空格，不要为了对齐增加空格。
6. 函数默认参数使用的赋值符左右省略空格。
7. 不要将多条语句写在同一行，尽管使用‘;’允许。
8. if/for/while语句中，即使执行语句只有一句，也必须另起一行 原则：避免不必要的空格

11.1.4. 变量命令总结

---

常见命名：

• 常量、类属性、全局变量
  • 全部大写，不同块之间下划线分割。 如： AF_INET, SOMAXCONN
• 函数、类方法
  • 全部小写，不同块之间下划线分割。 如： create_connection, setdefaulttimeout
• 类名
  • 首字母大写

示例如公共包：

import socket
socket.__dict__

---

驼峰命名法：

• 块之间直接连接
• 第一个块小写，后续块大写

如： getNewTime , getAdreess

【？待补充】