|
|
|
@@ -51,21 +51,21 @@ |
|
|
|
## 代码检视 Checklist 中英文参照表 |
|
|
|
|
|
|
|
| 检视项 | checklist | |
|
|
|
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | |
|
|
|
| ---------------------------------------------------------------------- |------------------------------------------------------------------------------------------------------------------------| |
|
|
|
| 是否进行空指针校验 | whether to verify the pointer is null/nullptr | |
|
|
|
| 是否进行返回值校验 | whether to verify the function's return value | |
|
|
|
| 是否正确释放new/malloc内存 | whether new/malloc memory is released correctly | |
|
|
|
| 是否修改热点函数/算法/算子 | whether to modify hotspot function / algorithm / operation | |
|
|
|
| 是否考虑并发场景 | whether to consider concurrent scenarios | |
|
|
|
| 是否考虑通信场景 | whether to consider communication scenario | |
|
|
|
| 是否符合编码规范 【编码规范】 | Whether to comply with coding specifications [coding specification reference] | |
|
|
|
| 是否遵守SOLID原则/迪米特法则 | Whether to comply with SOLID principle / Demeter's law | |
|
|
|
| 是否涉及模块/特性间交互【若涉及请概述实现思路】 | Whether the interaction between modules / features is involved (if yes, please outline the implementation ideas) | |
|
|
|
| 是否具备UT测试用例看护 && 测试用例为有效用例【若无测试用例请说明原因】 | Whether there is UT test case && the test case is a valid (if there is no test case, please explain the reason) | |
|
|
|
| 是否符合编码规范 【编码规范】 | whether to comply with coding specifications [coding specification reference] | |
|
|
|
| 是否遵守SOLID原则/迪米特法则 | whether to comply with SOLID principle / Demeter's law | |
|
|
|
| 是否涉及模块/特性间交互【若涉及请概述实现思路】 | whether the interaction between modules / features is involved (if yes, please outline the implementation ideas) | |
|
|
|
| 是否具备UT测试用例看护 && 测试用例为有效用例【若无测试用例请说明原因】 | whether there is UT test case && the test case is a valid (if there is no test case, please explain the reason) | |
|
|
|
| 秘钥是否被正确加载、释放 | whether the secret key is loaded/released correctly | |
|
|
|
| 是否充分考虑接口的异常场景 | whether the interface exception scenarios are fully considered | |
|
|
|
| 是否正确记录错误信息 | whether the error is recorded appropriately | |
|
|
|
| 是否涉及文档（安装、教程、设计、参考、API、迁移指南、FAQ等）修改 | Whether document (installation, tutorial, design, reference, API, migration guide, FAQ, etc.) modification is involved | |
|
|
|
| 是否导致无法前向兼容 | Whether it causes forward compatibility failure | |
|
|
|
| 是否为对外接口变更 | Whether the API change is involved | |
|
|
|
| 是否涉及依赖的三方库变更 | Whether the dependent third-party library change is involved | |
|
|
|
| 是否涉及文档（安装、教程、设计、参考、API、迁移指南、FAQ等）修改 | whether document (installation, tutorial, design, reference, API, migration guide, FAQ, etc.) modification is involved | |
|
|
|
| 是否导致无法前向兼容 | whether it causes forward compatibility failure | |
|
|
|
| 是否为对外接口变更 | whether the API change is involved | |
|
|
|
| 是否涉及依赖的三方库变更 | whether the dependent third-party library change is involved | |
i-robot
Gitee
2 years ago