CodeReview检查的问题

Code Review检查的问题

Code Review主要检查代码中是否存在以下方面问题：

• 完整性检查(Completeness)

1. 代码是否完全实现了设计文档中提出的功能需求
2. 代码是否已按照设计文档进行了集成和Debug
3. 代码是否已创建了需要的数据库，包括正确的初始化数据
4. 代码中是否存在任何没有定义或没有引用到的变量、常数或数据类型

• 一致性检查(Consistency)

1. 代码的逻辑是否符合设计文档
2. 代码中使用的格式、符号、结构等风格是否保持一致

• 正确性检查(Correctness)

1. 代码是否符合制定的标准
2. 所有的变量都被正确定义和使用
3. 所有的注释都是准确的
4. 所有的程序调用都使用了正确的参数个数

• 可修改性检查(Modifiability)

1. 代码涉及到的常量是否易于修改（如使用配置、定义为类常量、使用专门的常量类等）
2. 代码中是否包含了交叉说明或数据字典，以描述程序是如何对变量和常量进行访问的
3. 代码是否只有一个出口和一个入口（严重的异常处理除外）

• 可预测性检查(Predictability)

1. 代码所用的开发语言是否具有定义良好的语法和语义
2. 是否代码避免了依赖于开发语言缺省提供的功能
3. 代码是否无意中陷入了死循环
4. 代码是否避免了无穷递归

• 健壮性检查(Robustness)

1. 代码是否采取措施避免运行时错误（如数组边界溢出、被零除、值越界、堆栈溢出等）

• 结构性检查(Structuredness)

1. 程序的每个功能是否都作为一个可辨识的代码块存在
2. 循环是否只有一个入口

• 可追溯性检查(Traceability)

1. 代码是否对每个程序进行了唯一标识
2. 是否有一个交叉引用的框架可以用来在代码和开发文档之间相互对应
3. 代码是否包括一个修订历史记录、记录中对代码的修改和原因都有记录
4. 是否所有的安全功能都有标识

• 可理解性检查(Understandability)

1. 注释是否足够清晰的描述每个子程序
2. 是否使用到不明确或不必要的复杂代码，它们是否被清除的注释
3. 使用一些统一的格式化技巧（如缩进、空白等）用来增强代码的清晰度
4. 是否在定义命名规则时采用了便于记忆，反应类型等方法
5. 每个变量都定义了合法的取值范围
6. 代码中的算法是否符合开发文档中描述的数学模型

• 可验证性检查(Verifiability)

1. 代码中的实现技术是否便于测试