| 博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
|---|---|
| 作业要求 | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10616 |
| 课程目标 | 熟悉一个“高质量”软件的开发过程 |
| 作业目标 | 熟悉代码规范及结对互审 |
软件工程第三次作业
作业介绍
-
审查项目：报警记录系统
-
结对伙伴：刘佳迎
-
代码地址：代码地址
代码审查表
| 功能模块名称 | 报警记录系统 | ||
|---|---|---|---|
| 审查人 | 陈朗朗 | 审查日期 | 2020/4/15 |
| 代码名称 | waring-system.cpp | 代码作者 | 刘佳迎 |
| 文件结构 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 1 | 不重要 | 头文件和定义文件的名称是否合理？ | 是 |
| 2 | 不重要 | 头文件和定义文件的目录结构是否合理？ | 否 |
| 3 | 重要 | 版权和版本声明是否完整？ | 否 |
| 4 | 不重要 | 头文件中是否只存放“声明”而不存放“定义” | 是 |
| 程序的版式 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 1 | 不重要 | 空行是否得体？ | 否 |
| 2 | 不重要 | “{” 和 “}” 是否各占一行并且对齐于同一列？ | 是 |
| 3 | 重要 | 一行代码是否只做一件事？如只定义一个变量，只写一条语句。 | 是 |
| 4 | 重要 | 在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？ | 是 |
| 5 | 重要 | 注释是否有错误或者可能导致误解？ | 否 |
| 6 | 重要 | If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。 | 是 |
| 命名规则 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 1 | 重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致？ | 是 |
| 2 | 不重要 | 标识符是否直观且可以拼读？ | 是 |
| 3 | 不重要 | 标识符的长度应当符合“min-length && max-information”原则？ | 是 |
| 4 | 重要 | 程序中是否出现相同的局部变量和全部变量？ | 否 |
| 5 | 不重要 | 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ | 是 |
| 表达式与基本语句 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 1 | 重要 | 如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？ | 是 |
| 2 | 重要 | 是否将复合表达式与“真正的数学表达式”混淆？ | 否 |
| 3 | 重要 | 是否用隐含错误的方式写if语句? | 否 |
| 常量 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 1 | 不重要 | 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ | 是 |
| 2 | 不重要 | 在C++ 程序中，是否用const常量取代宏常量？ | 否 |
| 函数设计 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 1 | 不重要 | 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 是 |
| 2 | 不重要 | 参数命名、顺序是否合理？ | 是 |
| 3 | 不重要 | 是否省略了函数返回值的类型 | 否 |
| 4 | 不重要 | 函数名字与返回值类型在语义上是否冲突？ | 否 |
| 5 | 重要 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 | 否 |
| 6 | 重要 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 否 |
| 7 | 重要 | 使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。 | 否 |
| 8 | 重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 否 |
| 9 | 不重要 | 是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need” | 否 |
| 内存管理 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 1 | 重要 | 用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存） | 否 |
| 2 | 重要 | 是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用） | 是 |
| 3 | 重要 | 数组或指针的下标是否越界？ | 否 |
| 4 | 重要 | 动态内存的申请与释放是否配对？（防止内存泄漏） | 否 |
| 5 | 重要 | 是否有效地处理了“内存耗尽”问题？ | 否 |
| 6 | 重要 | 是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。 | 否 |
| 7 | 重要 | malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？ | 是 |
| 8 | 重要 | 在创建与释放动态对象数组时，new/delete的语句是否正确无误？ | 否 |
| 其它常见问题 | |||
| 序号 | 重要性 | 审查项 | 结论 |
| 1 | 重要 | 数据类型问题： | |
| （１）变量的数据类型有错误吗？ | 否 | ||
| （２）存在不同数据类型的赋值吗？ | 否 | ||
| （３）存在不同数据类型的比较吗？ | 否 | ||
| 2 | 重要 | 变量值问题： | |
| （１）变量的初始化或缺省值有错误吗？ | 否 | ||
| （２）变量发生上溢或下溢吗？ | 否 | ||
| （３）变量的精度够吗？ | 是 | ||
| 3 | 重要 | 逻辑判断问题： | |
| （１）由于精度原因导致比较无效吗？ | 否 | ||
| （２）表达式中的优先级有误吗？ | 否 | ||
| （３）逻辑判断结果颠倒吗？ | 否 | ||
| 4 | 重要 | 循环问题： | |
| （１）循环终止条件不正确吗？ | 否 | ||
| （２）无法正常终止（死循环）吗？ | 否 | ||
| （３）错误地修改循环变量吗？ | 否 | ||
| （４）存在误差累积吗？ | 否 | ||
| 5 | 重要 | 错误处理问题： | |
| （１）忘记进行错误处理吗？ | 是 | ||
| 6 | 重要 | 文件I/O问题： | |
| （１）对不存在的或者错误的文件进行操作吗？ | 否 | ||
| （２）文件以不正确的方式打开吗？ | 否 | ||
| （３）文件结束判断不正确吗？ | 否 | ||
| （４）没有正确地关闭文件吗? | 是 |
收获和评价
审查对象为报警记录系统的程序代码，该程序实现了三个等级报警信息的处理队列，并且保存在文件中。该系统设计完善，实现了功能性的同时也保证了易用性。
熟练的使用了栈和队列这种数据结构，使得从处理逻辑简化，并且让代码可读性增强，个人认为可以适当引入C++面对对象的特性，对功能进行抽象，这样会使代码更加灵活，容易添加新的功能。
从这份代码可以看出，作者逻辑思维很好，业务代码处理的条理清晰，个人建议可将功能模块化，用switch语句选用功能模块，会让代码看起来更清爽，模块化使更好的维护。
该代码注释清楚明了，关键部位的代码都有相应的注释，辅以较为规范的命名，使得代码容易理解，这点很值得学习。
C/C++的内存管理很重要但很容易被忽略，代码作者虽然通过良好的编码逻辑使没有出现内存错误，但是内存管理也要引起重视，例如内存空间的申请与初始化，使用结束后的正确释放等等。
总体来说是一份优秀的代码，使我收获颇多，也意识到了自己的不足之处，将改正。