一、代码审查表
| 功能模块名称 |
交通工具换乘方案制定 |
|
|
| 审查人 |
高鑫宇 |
审查日期 |
2020/4/14 |
| 代码名称 |
交通工具换乘.cpp |
代码作者 |
宿建 |
| 文件结构 |
|
|
| 重要性 |
审查项 |
结论 |
| |
头文件和定义文件的名称是否合理？ |
是 |
| |
头文件和定义文件的目录结构是否合理？ |
是 |
| |
版权和版本声明是否完整？ |
否 |
| 重要 |
头文件是否使用了 ifndef/define/endif 预处理块? |
是 |
| |
头文件中是否只存放“声明”而不存放“定义” |
否 |
| 程序的版式 |
|
|
| 重要性 |
审查项 |
结论 |
| |
空行是否得体？ |
是 |
| |
代码行内的空格是否得体？ |
是 |
| |
长行拆分是否得体？ |
是 |
| |
“{” 和 “}” 是否各占一行并且对齐于同一列？ |
是 |
| 重要 |
一行代码是否只做一件事？如只定义一个变量，只写一条语句。 |
是 |
| 重要 |
If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。 |
是 |
| 重要 |
在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？ |
是 |
| 重要 |
注释是否有错误或者可能导致误解？ |
否 |
| 命名规则 |
|
|
| 重要性 |
审查项 |
结论 |
| 重要 |
命名规则是否与所采用的操作系统或开发工具的风格保持一致？ |
是 |
| |
标识符是否直观且可以拼读？ |
是 |
| |
标识符的长度应当符合“min-length && max-information”原则？ |
是 |
| 重要 |
程序中是否出现相同的局部变量和全部变量？ |
否 |
| |
类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ |
是 |
| |
静态变量、全局变量、类的成员变量是否加前缀？ |
否 |
| 表达式与基本语句 |
|
|
| 重要性 |
审查项 |
结论 |
| 重要 |
如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？ |
是 |
| |
是否编写太复杂或者多用途的复合表达式？ |
否 |
| 重要 |
是否将复合表达式与“真正的数学表达式”混淆？ |
否 |
| 重要 |
是否用隐含错误的方式写if语句? 例如 |
|
| |
（1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。 |
否 |
| |
（2）将浮点变量用“==”或“！=”与任何数字比较。 |
否 |
| |
（3）将指针变量用“==”或“！=”与NULL比较。 |
否 |
| |
如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体的外面？ |
是 |
| 常量 |
|
|
| 重要性 |
审查项 |
结论 |
| |
是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ |
是 |
| |
在C++ 程序中，是否用const常量取代宏常量？ |
否 |
| 重要 |
如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ |
是 |
| |
生存期内是常量，而对于整个类而言却是可变的。 |
否 |
| 函数设计 |
|
|
| 重要性 |
审查项 |
结论 |
| |
参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 |
是 |
| |
参数命名、顺序是否合理？ |
是 |
| |
参数的个数是否太多？ |
否 |
| |
是否使用类型和数目不确定的参数？ |
否 |
| |
是否省略了函数返回值的类型？ |
否 |
| |
函数名字与返回值类型在语义上是否冲突？ |
否 |
| 重要 |
是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 |
否 |
| 重要 |
在函数体的“入口处”，是否用assert对参数的有效性进行检查？ |
否 |
| 重要 |
使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。 |
否 |
| 重要 |
return语句是否返回指向“栈内存”的“指针”或者“引用”？ |
否 |
| |
是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need” |
否 |
| 内存管理 |
|
|
| 重要性 |
审查项 |
结论 |
| 重要 |
是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用） |
否 |
| 重要 |
数组或指针的下标是否越界？ |
否 |
| 重要 |
动态内存的申请与释放是否配对？（防止内存泄漏） |
是 |
| 重要 |
是否有效地处理了“内存耗尽”问题？ |
是 |
| 重要 |
是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。 |
否 |
| 重要 |
在创建与释放动态对象数组时，new/delete的语句是否正确无误？ |
是 |
| C++函数的高级特性 |
|
|
| 重要性 |
审查项 |
结论 |
| |
重载函数是否有二义性？ |
否 |
| 重要 |
是否混淆了成员函数的重载、覆盖与隐藏？ |
否 |
| |
运算符的重载是否符合制定的编程规范？ |
是 |
| |
是否滥用内联函数？例如函数体内的代码比较长，函数体内出现循环。 |
否 |
| 重要 |
是否用内联函数取代了宏代码？ |
否 |
| 类的构造函数、析构函数和赋值函数 |
|
|
| 重要性 |
审查项 |
结论 |
| 重要 |
是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数： |
|
| |
（1）缺省的无参数构造函数； |
否 |
| |
（2）缺省的拷贝构造函数； |
否 |
| |
（3）缺省的析构函数； |
否 |
| |
（4）缺省的赋值函数。 |
否 |
| 重要 |
构造函数中是否遗漏了某些初始化工作？ |
否 |
| 重要 |
是否正确地使用构造函数的初始化表？ |
是 |
| 重要 |
析构函数中是否遗漏了某些清除工作？ |
否 |
| |
是否错写、错用了拷贝构造函数和赋值函数？ |
否 |
| 重要 |
赋值函数一般分四个步骤： |
|
| |
（1）检查自赋值； |
否 |
| |
（2）释放原有内存资源； |
是 |
| |
（3）分配新的内存资源，并复制内容； |
是 |
| |
（4）返回 *this。是否遗漏了重要步骤？ |
否 |
| 重要 |
是否正确地编写了派生类的构造函数、析构函数、赋值函数？ |
否 |
| 其它常见问题 |
|
|
| 重要性 |
审查项 |
结论 |
| 重要 |
数据类型问题： |
|
| |
（１）变量的数据类型有错误吗？ |
无 |
| |
（２）存在不同数据类型的赋值吗？ |
无 |
| |
（３）存在不同数据类型的比较吗？ |
无 |
| 重要 |
变量值问题： |
|
| |
（１）变量的初始化或缺省值有错误吗？ |
无 |
| |
（２）变量发生上溢或下溢吗？ |
无 |
| |
（３）变量的精度够吗？ |
是 |
| 重要 |
逻辑判断问题： |
|
| |
（１）由于精度原因导致比较无效吗？ |
无 |
| |
（２）表达式中的优先级有误吗？ |
无 |
| |
（３）逻辑判断结果颠倒吗？ |
无 |
| 重要 |
循环问题： |
|
| |
（１）循环终止条件不正确吗？ |
否 |
| |
（２）无法正常终止（死循环）吗？ |
否 |
| |
（３）错误地修改循环变量吗？ |
否 |
| |
（４）存在误差累积吗？ |
否 |
| 重要 |
错误处理问题： |
|
| |
（１）忘记进行错误处理吗？ |
否 |
| |
（２）错误处理程序块一直没有机会被运行？ |
否 |
| |
（３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。 |
否 |
| |
（４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。 |
否 |
二、代码地址
链接：https://github.com/1050966063/Homework-3/blob/master/main.cpp
三、评论
此次代码审查带给我很大的收获，我审查的是宿建同学对于交通工具换乘方案制定实现的代码，首先，我对他所实现的功能进行了了解：首先，城市交通图使用邻接矩阵这一数据结构设计，分别使用20个数字代表20各站点，并使用二位数组来存储路径上的权值。公交车线路与地铁线路分别使用两个二位数组来存储。接着，时间最短的换乘方案使用迪杰特斯拉算法（Dijkstra算法）进行计算，由于我所设计的交通图为矩形，而公交车线路为直线，所以换乘次数最少的换乘方案采用拐直角弯的路径，同时进行换乘。迪杰斯特拉算法是从一个顶点到其余各顶点的最短路径算法，解决的是有向图中最短路径问题。迪杰斯特拉算法主要特点是以起始点为中心向外层层扩展，直到扩展到终点为止。Dijkstra算法是很有代表性的最短路算法，在很多专业课程中都作为基本内容有详细的介绍，如数据结构，图论，运筹学等等。其基本思想是，设置顶点集合S并不断地作贪心选择来扩充这个集合。一个顶点属于集合S当且仅当从源到该顶点的最短路径长度已知。初始时，S中仅含有源。设u是G的某一个顶点，把从源到u且中间只经过S中顶点的路称为从源到u的特殊路径，并用数组dist记录当前每个顶点所对应的最短特殊路径长度。Dijkstra算法每次从V-S中取出具有最短特殊路长度的顶点u，将u添加到S中，同时对数组dist作必要的修改。一旦S包含了所有V中顶点，dist就记录了从源到所有其它顶点之间的最短路径长度。最后，程序运行时，只需输入2个不同站点即可，运行并输出时间最短和换乘次数最少的换乘方案。
他代码中最大的优点就是Dijkstra算法，这是我第一次对这个算法有了一定的了解，也是我此次审查工作中最大的收获。而且他的代码易读也容易理解，能够很好的实现所需要的功能。缺点部分代码稍有繁琐，以后可以试着更加简洁的实现功能。
以前代码审查对于我们来说是一件很陌生的事情，通过此次作业，我发现审查能显著提高代码质量，清楚点说，这不是单纯的代码标准和代码检查，而是使代码更高效。如果将来在一个团队里，每个人都有自己的背景和特长，而团队始终需要进步。因此总有人可能提出更聪明的解决方案，更合适的设计模式，或者能降低复杂性或提高性能的方法。使每个人都得到提高通过合作，每个人都可以相互学习并取得进步。提交代码者很有可能从该工作中得到反馈，并意识到可能存在的问题和需要改进的部分；而审查者也可以通过阅读他人代码学到新的东西，并找出适用于他们自己的工作方案。
总之，这次作业收获颇多，同时也感谢结对伙伴宿建同学的配合，在此也预祝宿建同学以后在工作中同样发光发彩！！！