DC娱乐网

项目管理体系-代码评审规范(Code Review)

代码评审需要做什么?

1完整性检查

2一致性检查

3正确性检查

4可预测性检查

5健壮性检查

6结构性检查

7可追溯性检查

8可理解性检查

9可验证性检查

  1. 完整性检查:确保代码完全实现了预定的功能需求,并且不存在未定义或未引用的变量、常数或数据类型。
  2. 一致性检查:检查代码逻辑是否符合设计文档,以及代码风格(如格式、符号和结构)是否保持一致。
  3. 正确性检查:验证代码是否符合制定的标准,包括变量定义和使用的正确性,以及注释的必要性和准确性。
  4. 可预测性检查:确保代码具有明确的语法和语义,避免死循环、无穷递归和内存泄漏等问题。
  5. 健壮性检查:检查代码是否采取措施避免运行时错误,如空指针异常等。
  6. 结构性检查:评估代码结构是否合理,避免过长的函数或嵌套过深的代码块。
  7. 可追溯性检查(虽未明确提及但可推断为代码变更的追踪能力):确保代码变更可被追踪和记录,便于后续维护和审计。
  8. 可理解性检查:验证注释是否足够清晰以描述代码逻辑,代码是否避免使用复杂且不必要的算法,并使用统一的格式化技巧来增强清晰度。
  9. 可验证性检查:确保代码中的实现技术便于测试,以便验证其功能和性能。