2020软件工程第三次作业
| 博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
|---|---|
| 作业要求 | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10616 |
| 课程目标 | 熟悉一个“高质量”软件的开发过程 |
| 作业目标 | 熟悉代码规范及结对互审 |
一、代码题目
通讯录管理系统
二、结对伙伴及程序源代码
https://github.com/beiliangdao/daimaku
三、代码审查
| 功能模块名称 | 通讯录管理系统 | |||
| 审查人 | 王志东 | 审查日期 | 2020/4/17 | |
| 代码名称 | 通讯录.cpp | 代码作者 | 苏豫轩 | |
| 文件结构 | ||||
| 重要性 | 审查项 | 结论 | ||
| 头文件和定义文件的名称是否合理？ | 是 | |||
| 头文件和定义文件的目录结构是否合理？ | 是 | |||
| 版权和版本声明是否完整？ | 是 | |||
| 重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | 无 | ||
| 头文件中是否只存放“声明”而不存放“定义” | 否 | |||
| 程序的版式 | ||||
| 重要性 | 审查项 | 结论 | ||
| 空行是否得体？ | 是 | |||
| 代码行内的空格是否得体？ | 是 | |||
| 长行拆分是否得体？ | 是 | |||
| “{” 和 “}” 是否各占一行并且对齐于同一列？ | 是 | |||
| 重要 | 一行代码是否只做一件事？如只定义一个变量，只写一条语句。 | 是 | ||
| 重要 | If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。 | 是 | ||
| 重要 | 在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？ | 是 | ||
| 重要 | 注释是否有错误或者可能导致误解？ | 否 | ||
| 重要 | 类结构的public, protected, private顺序是否在所有的程序中保持一致？ | 是 | ||
| 命名规则 | ||||
| 重要性 | 审查项 | 结论 | ||
| 重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致？ | 是 | ||
| 标识符是否直观且可以拼读？ | 是 | |||
| 标识符的长度应当符合“min-length && max-information”原则？ | 是 | |||
| 重要 | 程序中是否出现相同的局部变量和全部变量？ | 否 | ||
| 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ | 是 | |||
| 静态变量、全局变量、类的成员变量是否加前缀？ | 是 | |||
| 表达式与基本语句 | ||||
| 重要性 | 审查项 | 结论 | ||
| 重要 | 如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？ | 是 | ||
| 是否编写太复杂或者多用途的复合表达式？ | 否 | |||
| 重要 | 是否将复合表达式与“真正的数学表达式”混淆？ | 否 | ||
| 重要 | 是否用隐含错误的方式写if语句? 例如 | |||
| （1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 否 | |||
| （2）将浮点变量用“==”或“！=”与任何数字比较。 | 否 | |||
| （3）将指针变量用“==”或“！=”与NULL比较。 | 否 | |||
| 如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体的外面？ | 否 | |||
| 重要 | Case语句的结尾是否忘了加break？ | 否 | ||
| 重要 | 是否忘记写switch的default分支？ | 无 | ||
| 重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 无 | ||
| 常量 | ||||
| 重要性 | 审查项 | 结论 | ||
| 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ | 是 | |||
| 在C++ 程序中，是否用const常量取代宏常量？ | 否 | |||
| 重要 | 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ | 是 | ||
| 函数设计 | ||||
| 重要性 | 审查项 | 结论 | ||
| 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 是 | |||
| 参数命名、顺序是否合理？ | 是 | |||
| 参数的个数是否太多？ | 否 | |||
| 是否使用类型和数目不确定的参数？ | 否 | |||
| 是否省略了函数返回值的类型？ | 否 | |||
| 函数名字与返回值类型在语义上是否冲突？ | 否 | |||
| 重要 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 | 否 | ||
| 重要 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 否 | ||
| 重要 | 使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。 | 无 | ||
| 重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 否 | ||
| 是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need” | 否 | |||
| 其它常见问题 | ||||
| 重要性 | 审查项 | 结论 | ||
| 重要 | 数据类型问题： | |||
| （１）变量的数据类型有错误吗？ | 否 | |||
| （２）存在不同数据类型的赋值吗？ | 否 | |||
| （３）存在不同数据类型的比较吗？ | 否 | |||
| 重要 | 变量值问题： | |||
| （１）变量的初始化或缺省值有错误吗？ | 否 | |||
| （２）变量发生上溢或下溢吗？ | 否 | |||
| （３）变量的精度够吗？ | 是 | |||
| 重要 | 逻辑判断问题： | |||
| （１）由于精度原因导致比较无效吗？ | 否 | |||
| （２）表达式中的优先级有误吗？ | 否 | |||
| （３）逻辑判断结果颠倒吗？ | 否 | |||
| 重要 | 循环问题： | |||
| （１）循环终止条件不正确吗？ | 否 | |||
| （２）无法正常终止（死循环）吗？ | 否 | |||
| （３）错误地修改循环变量吗？ | 否 | |||
| （４）存在误差累积吗？ | 否 | |||
| 重要 | 错误处理问题： | |||
| （１）忘记进行错误处理吗？ | 否 | |||
| （２）错误处理程序块一直没有机会被运行？ | 否 | |||
| （３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。 | 否 | |||
| （４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。 | 否 | |||
| 重要 | 文件I/O问题： | |||
| （１）对不存在的或者错误的文件进行操作吗？ | 否 | |||
| （２）文件以不正确的方式打开吗？ | 否 | |||
| （３）文件结束判断不正确吗？ | 否 | |||
|
|
（４）没有正确地关闭文件吗? |
否 |
||
四、同伴代码评价
优点：
- 代码结构清晰，可读性很好。
- 代码编写很规范性。
- 在变量定义上添加了必要的注释，便于更快更好地理解代码。
- 控制台的显示清晰、规范、整洁。
缺点：
- 在遇到不正常QQ长度时，会报错。
- 程序的注释还是不够完整。
五、自我总结
通过这次结对作业审查小伙伴的代码，我收获了很多，熟悉了代码规范及结对互审。了解到在代码编写上很多值得学习的地方。代码的结构非常清晰，编写十分规范。控制台程序运行界面简洁明朗，代码的编写能力非常成熟，希望在今后的学习中能学习更多，共同进步。
