软件工程第一次结对作业
| 博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
|---|---|
| 作业要求 | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10616 |
| 课程目标 | 熟悉一个“高质量”软件的开发过程 |
| 作业目标 | 单元测试练习 |
程序内容
现在某个旅游公司要根据客户实际需求为其制定个性化旅游路线，要求能够考虑价格、距离等因素具体要求如下：
- 1.采取有向图的方式存储路线信息；
- 2.应该可以保存各景点之间的距离、价格等信息；
- 3.能够根据用户实际需求为客户提供距离优先、价格优先或者距离+价格优先等多种方案
- 4.要求景点数量至少超过20个，有向图应为连通图；
代码审查
| 功能模块名称 | 个性化旅游路线推荐系统 | ||
| 审查人 | 张号 | 审查日期 | 2020/4/16 |
| 代码名称 | main.cpp | 代码作者 | 杨莹莹 |
| 文件结构 | |||
| 重要性 | 审查项 | 结论 | |
| 头文件和定义文件的名称是否合理？ | 是 | ||
| 头文件和定义文件的目录结构是否合理？ | 是 | ||
| 版权和版本声明是否完整？ | 否 | ||
| 重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | 没编写相关头文件 | |
| 头文件中是否只存放“声明”而不存放“定义” | 没编写相关头文件 | ||
| 程序的版式 | |||
| 重要性 | 审查项 | 结论 | |
| 空行是否得体？ | 是 | ||
| 代码行内的空格是否得体？ | 否 | ||
| 长行拆分是否得体？ | 否 | ||
| “{” 和 “}” 是否各占一行并且对齐于同一列？ | 部分代码未满足此规范 | ||
| 重要 | 一行代码是否只做一件事？如只定义一个变量，只写一条语句。 | 存在一行代码定义多变量问题 | |
| 重要 | 是否满足If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。 | 是 | |
| 重要 | 在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？ | 是 | |
| 重要 | 注释是否有错误或者可能导致误解？ | 否 | |
| 重要 | 类结构的public, protected, private顺序是否在所有的程序中保持一致？ | 未涉及到相关类结构 | |
| 表达式与基本语句 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？ | 是 | |
| 是否编写太复杂或者多用途的复合表达式？ | 否 | ||
| 重要 | 是否将复合表达式与“真正的数学表达式”混淆？ | 否 | |
| 重要 | 是否用隐含错误的方式写if语句? 例如 | ||
| (1）是否将布尔变量直接与TRUE、FALSE或者1、0进行比较？ | 未涉及布尔变量 | ||
| (2）是否浮点变量用“==”或“！=”与任何数字比较？ | 否 | ||
| (3）将指针变量用“==”或“！=”与NULL比较。 | 否 | ||
| 如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体的外面？ | 否 | ||
| 重要 | Case语句的结尾是否忘了加break？ | 否 | |
| 重要 | 是否忘记写switch的default分支？ | 否 | |
| 重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 未使用goto语句 | |
| 命名的规则 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致？ | 是 | |
| 标识符是否直观且可以拼读？ | 是 | ||
| 标识符的长度是否符合“min-length && max-information”原则？ | 是 | ||
| 重要 | 程序中是否出现相同的局部变量和全部变量？ | 否 | |
| 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ | 是 | ||
| 静态变量、全局变量、类的成员变量是否加前缀？ | 否 | ||
| 常量 | |||
| 重要性 | 审查项 | 结论 | |
| 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ | 是 | ||
| 在C++程序中，是否用const常量取代宏常量？ | 否 | ||
| 重要 | 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ | 不存在某一常量与其它常量密切相关 | |
| 函数设计 | |||
| 重要性 | 审查项 | 结论 | |
| 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 是 | ||
| 参数命名、顺序是否合理？ | 是 | ||
| 参数的个数是否太多？ | 否 | ||
| 是否使用类型和数目不确定的参数？ | 否 | ||
| 是否省略了函数返回值的类型？ | 否 | ||
| 函数名字与返回值类型在语义上是否冲突？ | 否 | ||
| 重要 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 | 否 | |
| 重要 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 否 | |
| 重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 否 | |
| 是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need” | 否 | ||
| 其它常见问题 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 数据类型问题： | ||
| （１）变量的数据类型是否有错误？ | 否 | ||
| （２）是否存在不同数据类型的赋值？ | 否 | ||
| （３）是否存在不同数据类型的比较？ | 否 | ||
| 重要 | 变量值问题： | ||
| （１）变量的初始化或缺省值是否有错误？ | 否 | ||
| （２）变量是否发生上溢或下溢？ | 否 | ||
| （３）变量的精度是否够？ | 是 | ||
| 重要 | 逻辑判断问题： | ||
| （1）是否存在由于精度原因导致比较无效？ | 否 | ||
| （2）表达式中的优先级是否存在错误？ | 否 | ||
| （3）逻辑判断结果是否存在颠倒？ | 否 | ||
| 重要 | 文件I/O问题： | ||
| （1）是否存在对不存在的或者错误的文件进行操作？ | 否 | ||
| （2）是否存在文件以不正确的方式打开？ | 否 | ||
| （3）是否存在文件结束判断不正确？ | 否 | ||
| （4）是否存在不正确地关闭文件? | 否 | ||
对PARTNER的评价
杨莹莹的这份代码整体实现题目要求的所有功能，代码风格能做到前后一致，无重大致命bug，但在一些细节处理方面尚有不足，比如“{”和“}”的对齐问题，希望他能懂得我上表提出的问题并做出改进，更上一层楼。
自我总结
通过这次结对互审作业，我加深对互审步骤的理解，也同时复习了代码编写注意事项和相关规范，希望下次能和我的partner进行一次协作开发项目。
