结对项目1.0之代码审查
- c++代码审查表
代码审查表参考了这篇博客
以下是代码审查表的内容，在Mardown编辑器中使用HTML方式插入。
我的结对作业队友是4班张洁，代码功能是利用子集构造法实现NFA到DFA的转换。
| 功能模块名称 | 利用子集构造法实现NFA到DFA的转换 | ||
| 审查人 | 刘子博 | 审查日期 | 2018.4.5 |
| 代码名称 | 利用子集构造法实现NFA到DFA的转换 | 代码作者 | 张洁 |
| 文件结构 | |||
| 重要性 | 审查项 | 结论 | |
| 头文件和定义文件的名称是否合理？ | 合理 | ||
| 头文件和定义文件的目录结构是否合理？ | 合理 | ||
| 版权和版本声明是否完整？ | 不完整 无版权和版本声明 | ||
| 重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | 没有使用预处理模块 | |
| 头文件中是否只存放“声明”而不存放“定义” | 是 | ||
| 程序的版式 | |||
| 重要性 | 审查项 | 结论 | |
| 空行是否得体？ | 得体 | ||
| 代码行内的空格是否得体？ | 得体 | ||
| 长行拆分是否得体？ | 得体 | ||
| “{” 和 “}” 是否各占一行并且对齐于同一列？ | 是 | ||
| 重要 | 一行代码是否只做一件事？如只定义一个变量，只写一条语句。 | 是 | |
| 重要 | If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。 | if执行单行语句时没有加{} | |
| 重要 | 在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？ | 是，注释清晰必要 | |
| 重要 | 注释是否有错误或者可能导致误解？ | 没有 | |
| 重要 | 类结构的public, protected, private顺序是否在所有的程序中保持一致？ | 保持一致 | |
| 命名规则 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致？ | 是 | |
| 标识符是否直观且可以拼读？ | 是 | ||
| 标识符的长度应当符合“min-length && max-information”原则？ | 是 首要变量或函数命名有明确的含义且名字尽量短，包含信息量多 | ||
| 重要 | 程序中是否出现相同的局部变量和全部变量？ | 无 | |
| 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ | 遵循 | ||
| 静态变量、全局变量、类的成员变量是否加前缀？ | 加了 | ||
| 表达式与基本语句 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？ | 是 | |
| 是否编写太复杂或者多用途的复合表达式？ | 否 | ||
| 重要 | 是否将复合表达式与“真正的数学表达式”混淆？ | 否 | |
| 重要 | 是否用隐含错误的方式写if语句? 例如 | 否 | |
| （1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 否 | ||
| （2）将浮点变量用“==”或“！=”与任何数字比较。 | 否 | ||
| （3）将指针变量用“==”或“！=”与NULL比较。 | 否 | ||
| 如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判 | 是 | ||
| 断移到循环体的外面？ | |||
| 重要 | Case语句的结尾是否忘了加break？ | 没有case语句 | |
| 重要 | 是否忘记写switch的default分支？ | 没有switch | |
| 重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 没有使用goto语句 | |
| 常量 | |||
| 重要性 | 审查项 | 结论 | |
| 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ | 是 | ||
| 在C++ 程序中，是否用const常量取代宏常量？ | 使用了const常量 | ||
| 重要 | 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ | 没有 | |
| 是否误解了类中的const数据成员？因为const数据成员只在某个对象 | 没有 | ||
| 生存期内是常量，而对于整个类而言却是可变的。 | |||
| 函数设计 | |||
| 重要性 | 审查项 | 结论 | |
| 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 完整 没有只写参数名字 | ||
| 参数命名、顺序是否合理？ | 合理 | ||
| 参数的个数是否太多？ | 不多 | ||
| 是否使用类型和数目不确定的参数？ | 没有使用 | ||
| 是否省略了函数返回值的类型？ | 没有省略 | ||
| 函数名字与返回值类型在语义上是否冲突？ | 不冲突 | ||
| 重要 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 | 没有混在一起返回 | |
| 重要 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 没有使用 | |
| 重要 | 使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。 | 没有滥用 | |
| 重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 没有 | |
| 是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need” | 没有使用 | ||
| 内存管理 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存） | 没有使用 | |
| 重要 | 是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用） | 没有忘记 | |
| 重要 | 数组或指针的下标是否越界？ | 不越界 | |
| 重要 | 动态内存的申请与释放是否配对？（防止内存泄漏） | 配对 | |
| 重要 | 是否有效地处理了“内存耗尽”问题？ | 处理了 | |
| 重要 | 是否修改“指向常量的指针”的内容？ | 没有修改 | |
| 重要 | 是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。 | 没有野指针 | |
| 重要 | 是否将malloc/free 和 new/delete 混淆使用？ | 没有混用 | |
| 重要 | malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？ | 没有使用malloc | |
| 重要 | 在创建与释放动态对象数组时，new/delete的语句是否正确无误？ | 正确 | |
| C++ 函数的高级特性 | |||
| 重要性 | 审查项 | 结论 | |
| 重载函数是否有二义性？ | 没有 | ||
| 重要 | 是否混淆了成员函数的重载、覆盖与隐藏？ | 没有 | |
| 运算符的重载是否符合制定的编程规范？ | 符合 | ||
| 是否滥用内联函数？例如函数体内的代码比较长，函数体内出现循环。 | 没有滥用 | ||
| 重要 | 是否用内联函数取代了宏代码？ | 没有 | |
| 类的构造函数、析构函数和赋值函数 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数： | 否 | |
| （1）缺省的无参数构造函数； | 否 | ||
| （2）缺省的拷贝构造函数； | 否 | ||
| （3）缺省的析构函数； | 否 | ||
| （4）缺省的赋值函数。 | 否 | ||
| 重要 | 构造函数中是否遗漏了某些初始化工作？ | 否 | |
| 重要 | 是否正确地使用构造函数的初始化表？ | 是 | |
| 重要 | 析构函数中是否遗漏了某些清除工作？ | 否 | |
| 是否错写、错用了拷贝构造函数和赋值函数？ | 否 | ||
| 重要 | 赋值函数一般分四个步骤： | ||
| （1）检查自赋值； | |||
| （2）释放原有内存资源； | |||
| （3）分配新的内存资源，并复制内容； | |||
| （4）返回 *this。是否遗漏了重要步骤？ | 否 | ||
| 重要 | 是否正确地编写了派生类的构造函数、析构函数、赋值函数？ | 是 | |
| 注意事项： | |||
| （1）派生类不可能继承基类的构造函数、析构函数、赋值函数。 | |||
| （2）派生类的构造函数应在其初始化表里调用基类的构造函数。 | |||
| （3）基类与派生类的析构函数应该为虚（即加virtual关键字）。 | |||
| （4）在编写派生类的赋值函数时，注意不要忘记对基类的数据成员重新赋值 | |||
| 类的高级特性 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 是否违背了继承和组合的规则？ | 否 | |
| （1）若在逻辑上B是A的“一种”，并且A的所有功能和属性对B而言都有意义，则允许B继承A的功能和属性。 | |||
| （2）若在逻辑上A是B的“一部分”（a part of），则不允许B从A派生，而是要用A和其它东西组合出B。 | |||
| 其它常见问题 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 数据类型问题： | ||
| （１）变量的数据类型有错误吗？ | 没有 | ||
| （２）存在不同数据类型的赋值吗？ | 不存在 | ||
| （３）存在不同数据类型的比较吗？ | 不存在 | ||
| 重要 | 变量值问题： | ||
| （１）变量的初始化或缺省值有错误吗？ | 没有 | ||
| （２）变量发生上溢或下溢吗？ | 没有 | ||
| （３）变量的精度够吗？ | 够 | ||
| 重要 | 逻辑判断问题： | ||
| （１）由于精度原因导致比较无效吗？ | 没有 | ||
| （２）表达式中的优先级有误吗？ | 没有 | ||
| （３）逻辑判断结果颠倒吗？ | 没有 | ||
| 重要 | 循环问题： | ||
| （１）循环终止条件不正确吗？ | 正确 | ||
| （２）无法正常终止（死循环）吗？ | 没有 | ||
| （３）错误地修改循环变量吗？ | 没有 | ||
| （４）存在误差累积吗？ | 不存在 | ||
| 重要 | 错误处理问题： | ||
| （１）忘记进行错误处理吗？ | 没有 | ||
| （２）错误处理程序块一直没有机会被运行？ | 没有 | ||
| （３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。 | 没有 | ||
| （４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。 | 不是 | ||
| 重要 | 文件I/O问题： | ||
| （１）对不存在的或者错误的文件进行操作吗？ | 没有 | ||
| （２）文件以不正确的方式打开吗？ | 没有 | ||
| （３）文件结束判断不正确吗？ | 正确 | ||
| （４）没有正确地关闭文件吗? | 正确关闭 | ||
-
小结&代码评价
我的结对作业队友是4班张洁，代码功能是实现利用子集构造法实现NFA到DFA的转换。
代码审查是保证代码质量的有效手段，做得好的话对项目来说是一笔收益颇高的时间投资。
通过填写对这个程序而言的代码审查表，我知道了在编写程序时应该注意的事项以及必须遵守的代码规范，还有应该对代码版权和版本声明进行说明，以前编写代码时候并没有注意过这个问题，现在知道了。
以下是我对张洁同学的代码的一些评价：
首先，从文件结构方面来看，代码的头文件和定义文件的名称合理，但是也同样没有对版权和版本声明进行说明，但是整体来说文件结构方面还是非常完整的。
第二，从程序版式方面来看，代码的结构非常得体，非常规范，注释清晰且必要，但是还有一点点小问题，就是if执行单行语句是没有加“{}”。
第三，在命名规则和表达式与基本语句方面，代码清晰的规定了每一个变量的名称，也没有使用可能使代码顺序混乱的goto等语句，整体来说非常规范。
第四，在函数的设计方面，代码使用了调用子函数的方法设计，主函数内部清晰明了，没有冗余的语句，参数的定义完整，也没有对内存操作的错误操作，指针没有越界，整体读下来没有太大障碍。
最后，在许多常见问题方面，也没有出现错误，总体来说非常规范。 -
代码清单
代码清单
