代码审查表分析和总结.pdf

北京康吉森交通技术有限公司—项目名称 代码审查表 附录C ：C++/C 代码审查表 文件结构 重要 审查项 结论 性 头文件和定义文件的名称是否合理？ 头文件和定义文件的目录结构是否合 理？ 版权和版本声明是否完整？ 重要 头文件是否使用了 ifndef/define/endif 预处理块? 头文件中是否只存放 “声明”而不存放“定 义” …… 程序的版式 重要 审查项 结论 性 空行是否得体？ 代码行内的空格是否得体？ 长行拆分是否得体？ “ ” 和 “}” 是否各占一行并且对齐于同 一列？ 重要 一行代码是否只做一件事？如只定义一 个变量，只写一条语句。 重要 If 、for 、while 、do 等语句自占一行，不 论执行语句多少都要加“ {} ”。 重要 在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？ 注释是否清晰并且必要？ 重要 注释是否有错误或者可能导致误解？ 重要 类结构的 public, protected, private 顺序是 否在所有的程序中保持一致？ …… 命名规则 重要 审查项 结论 性 重要 命名规则是否与所采用的操作系统或开 发工具的风格保持一致？ 版权所有 第 1 页 共 6 页 北京康吉森交通技术有限公司—项目名称 代码审查表 标识符是否直观且可以拼读？ 标识符的长度应当符合“ min-length max-information ”原则？ 重要 程序中是否出现相同的局部变量和全部 变量？ 类名、函数名、变量和参数、常量的书写 格式是否遵循一定的规则？ 静态变量、全局变量、类的成员变量是否 加前缀？ …… 表达式与基本语句 重要 审查项 结论 性 重要 如果代码行中的运算符比较多， 是否已经 用括号清楚地确定表达式的操作顺序？ 是否编写太复杂或者多用途的复合表达 式？ 重要 是否将复合表达式与“真正的数学表达 式”混淆？ 重要 是否用隐含错误的方式写 if 语句? 例如 （1）将布尔变量直接与 TRUE、FALSE 或者 1、0进行比较。 （2）将浮点变量用“==”或“！=”与任 何数字比较。 （3）将指针变量用“ == ”或“！= ”与 NULL 比较。 如果循环体内存在逻辑判断，并且循环次 数很大，是否已经将逻辑判断移到循环体 的外面？ 重要 Case 语句的结尾是否忘了加 break ？ 重要 是否忘记写 switch 的default 分支？ 重要 使用 goto 语句时是否留下隐患 ? 例如 跳过了某些对象的构造、变量的初始化、 重要的计算等。 „„