| 博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
|---|---|
| 作业要求 | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10616 |
| 课设目标 | 熟悉一个“高质量”软件的开发过程 |
| 作业目标 | 熟悉代码规范及结对互审 |
一. 结对伙伴代码地址
https://github.com/Library-cll/Minimum-spanning-tree/tree/master/课设
二. 代码审查
| 功能模块名称 | 通信网络构建最小成本计算问题 | ||
|---|---|---|---|
| 审查人 | 刘佳迎 | 审查日期 | 2020.04.15 |
| 代码名称 | main Prim Mgraph Kruskal | 代码作者 | 陈郎朗 |
| 文件结构 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 1 | 不重要 | 头文件和定义文件的名称是否合理？ | 是 |
| 2 | 不重要 | 头文件和定义文件的目录结构是否合理？ | 是 |
| 3 | 不重要 | 版权和版本声明是否完整？ | 无 |
| 4 | 重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | 无 |
| 5 | 不重要 | 头文件中是否只存放“声明”而不存放“定义” | 是 |
| 程序的板式 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 6 | 不重要 | 空行是否得体？ | 是 |
| 7 | 不重要 | 代码行内的空格是否得体？ | 是 |
| 8 | 不重要 | 长行拆分是否得体？ | 无 |
| 9 | 不重要 | “{” 和 “}” 是否各占一行并且对齐于同一列？ | 是 |
| 10 | 重要 | 一行代码是否只做一件事？如只定义一个变量，只写一条语句 | 是 |
| 11 | 重要 | If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。 | 否 |
| 12 | 重要 | 在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？ | 是 |
| 13 | 重要 | 注释是否有错误或者可能导致误解？ | 否 |
| 14 | 重要 | 类结构的public, protected, private顺序是否在所有的程序中保持一致？ | 无 |
| 命名规则 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 15 | 重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致？ | 是 |
| 16 | 不重要 | 标识符是否直观且可以拼读？ | 是 |
| 17 | 不重要 | 标识符的长度应当符合“min-length && max-information”原则？ | 无 |
| 18 | 重要 | 程序中是否出现相同的局部变量和全部变量？ | 否 |
| 19 | 不重要 | 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ | 是 |
| 20 | 不重要 | 静态变量、全局变量、类的成员变量是否加前缀？ | 否 |
| 表达式与基本语句 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 21 | 重要 | 如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？ | 无 |
| 22 | 不重要 | 是否编写太复杂或者多用途的复合表达式？ | 否 |
| 23 | 重要 | 是否将复合表达式与“真正的数学表达式”混淆？ | 否 |
| 24 | 重要 | （1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 无 |
| 25 | 重要 | （2）将浮点变量用“==”或“！=”与任何数字比较。 | 无 |
| 26 | 重要 | （3）将指针变量用“==”或“！=”与NULL比较。 | 无 |
| 27 | 不重要 | 如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体的外面？ | 否 |
| 28 | 重要 | Case语句的结尾是否忘了加break？ | 否 |
| 29 | 重要 | 是否忘记写switch的default分支？ | 否 |
| 30 | 重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 无 |
| 常量 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 31 | 不重要 | 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ | 是 |
| 32 | 不重要 | 在C++ 程序中，是否用const常量取代宏常量？ | 无 |
| 33 | 重要 | 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ | 是 |
| 34 | 不重要 | 是否误解了类中的const数据成员？因为const数据成员只在某个对象 | 无 |
| 35 | 不重要 | 生存期内是常量，而对于整个类而言却是可变的。 | 无 |
| 函数设计 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 36 | 不重要 | 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 是 |
| 37 | 不重要 | 参数命名、顺序是否合理？ | 是 |
| 38 | 不重要 | 参数的个数是否太多？ | 否 |
| 39 | 不重要 | 是否使用类型和数目不确定的参数？ | 否 |
| 40 | 不重要 | 是否省略了函数返回值的类型？ | 否 |
| 41 | 不重要 | 函数名字与返回值类型在语义上是否冲突？ | 否 |
| 42 | 重要 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 | 否 |
| 43 | 重要 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 无 |
| 44 | 重要 | 使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。 | 无 |
| 45 | 重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 否 |
| 46 | 不重要 | 是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need” | 无 |
| 内存管理 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 47 | 重要 | 用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存） | 无 |
| 48 | 重要 | 是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用） | 否 |
| 49 | 重要 | 数组或指针的下标是否越界？ | 否 |
| 50 | 重要 | 动态内存的申请与释放是否配对？（防止内存泄漏） | 无 |
| 51 | 重要 | 是否有效地处理了“内存耗尽”问题？ | 无 |
| 52 | 重要 | 是否修改“指向常量的指针”的内容？ | 否 |
| 53 | 重要 | 是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。 | 无 |
| 54 | 重要 | 是否将malloc/free 和 new/delete 混淆使用？ | 无 |
| 55 | 重要 | malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？ | 无 |
| 56 | 重要 | 在创建与释放动态对象数组时，new/delete的语句是否正确无误？ | 无 |
| C++函数的高级特性 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 57 | 不重要 | 重载函数是否有二义性？ | 无 |
| 58 | 重要 | 是否混淆了成员函数的重载、覆盖与隐藏？ | 无 |
| 59 | 不重要 | 运算符的重载是否符合制定的编程规范？ | 无 |
| 60 | 不重要 | 是否滥用内联函数？例如函数体内的代码比较长，函数体内出现循环。 | 无 |
| 61 | 重要 | 是否用内联函数取代了宏代码？ | 无 |
| 其它常见问题 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 62 | 重要 | 变量的数据类型有错误吗？ | 否 |
| 63 | 重要 | 存在不同数据类型的赋值吗？ | 否 |
| 64 | 重要 | 存在不同数据类型的比较吗？ | 否 |
| 65 | 重要 | 变量的初始化或缺省值有错误吗？ | 否 |
| 66 | 重要 | 变量发生上溢或下溢吗？ | 否 |
| 67 | 重要 | 变量的精度够吗？ | 是 |
| 68 | 重要 | 由于精度原因导致比较无效吗？ | 否 |
| 69 | 重要 | 表达式中的优先级有误吗？ | 否 |
| 70 | 重要 | 逻辑判断结果颠倒吗？ | 否 |
| 71 | 重要 | 循环终止条件不正确吗？ | 否 |
| 72 | 重要 | 无法正常终止（死循环）吗？ | 否 |
| 73 | 重要 | 错误地修改循环变量吗？ | 否 |
| 74 | 重要 | 存在误差累积吗？ | 否 |
| 75 | 重要 | 忘记进行错误处理吗？ | 是 |
三. 总体评价
此次审查的代码功能是实现通信网络构建成本最小，因为代码中使用了三种算法实现成本最小，放在一个项目中代码太长，可读性相对来说就会差，所以，我的队友根据三种不同的算法，分别建了Prim，Mgraph，Kruskal三个算法项目和main主函数。这样将三个算法分开建项，可以使我更便捷的了解各个算法求最小成本的原理，也不会因为代码过长而将三个算法弄混。并且，代码过长会使审查代码时出现错误，这样分开使得审查代码会更方便，不会出现因代码过长而出现审阅倦怠的问题。
队友在对代码的处理上也很细腻，变量的定义及函数的命名都能很好的应对题目，更能直观的明白哪个函数和变量对应的功能是什么，思路清晰。代码在感官上排版合理，给人感觉十分工整。虽说代码较长，但都覆盖重点，可以让读者更容易理解各模块的作用。
由于代码功能较多，理解起来相对困难，对于结对编程来说，应该有较多重要的注释，但队友的代码在各个功能模块出并没有做过多的注释，使得我在审查代码时比较费劲，有些功能函数还需问队友才能理解整个模块的功能，这一点是需要改进的。还有在进行调试时，虽说基本的要求都能实现，但涉及到跨远城市是的设定还是没有考虑到，使得此次代码对于项目的时间并不全面，还可以进行改进，使得使用的范围更大。调试界面输出的排版上也出现了一个小问题，导致看起来不是特别美观，也需要改进。
总的来说代码完成质量很好，只是一些方面考虑得不全面，希望在今后代码书写中可以考虑的完善写，更高质量的完成代码的书写。