21 lines
2.1 KiB
Markdown
21 lines
2.1 KiB
Markdown
# import 规范
|
|
在从外部库进行导入时候，请遵循以下顺序：
|
|
1. 对于标准库和第三方库的导入，请按照如下顺序：
|
|
- 需要使用`from ... import ...`语法的导入放在前面。
|
|
- 直接使用`import ...`语法的导入放在后面。
|
|
- 对于使用`from ... import ...`导入的多个项，请**在保证不会引起import错误的前提下**，按照**字母顺序**排列。
|
|
- 对于使用`import ...`导入的多个项，请**在保证不会引起import错误的前提下**，按照**字母顺序**排列。
|
|
2. 对于本地模块的导入，请按照如下顺序：
|
|
- 对于同一个文件夹下的模块导入，使用相对导入，排列顺序按照**不发生import错误的前提下**，随便排列。
|
|
- 对于不同文件夹下的模块导入，使用绝对导入。这些导入应该以`from src`开头，并且按照**不发生import错误的前提下**，尽量使得第二层的文件夹名称相同的导入放在一起；第二层文件夹名称排列随机。
|
|
3. 标准库和第三方库的导入应该放在本地模块导入的前面。
|
|
4. 各个导入块之间应该使用一个空行进行分隔。
|
|
|
|
# 代码规范
|
|
## 注释规范
|
|
1. 尽量保持良好的注释
|
|
2. 如果原来的代码中有注释，则重构的时候，除非这部分代码被删除，否则相同功能的代码应该保留注释（可以对注释进行修改以保持准确性，但不应该删除注释）。
|
|
3. 如果原来的代码中没有注释，则重构的时候，如果某个功能块的代码较长或者逻辑较为复杂，则应该添加注释来解释这部分代码的功能和逻辑。
|
|
## 类型注解规范
|
|
1. 重构代码时，如果原来的代码中有类型注解，则相同功能的代码应该保留类型注解（可以对类型注解进行修改以保持准确性，但不应该删除类型注解）。
|
|
2. 重构代码时，如果原来的代码中没有类型注解，则重构的时候，如果某个函数的功能较为复杂或者参数较多，则应该添加类型注解来提高代码的可读性和可维护性。（对于简单的变量，可以不添加类型注解） |