| 博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
|---|---|
| 作业要求 | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10616 |
| 课程目标 | 熟悉一个“高质量”软件的开发过程 |
| 作业目标 | 熟悉代码规范及结对互审 |
一、同伴代码
二、审查表
| 功能模块名称 | 银行排号系统 | |
|---|---|---|
| 审查人 | 卢栓红 | |
| 代码作者 | 章璐 | |
| 文件结构 | ||
| 重要性 | 审查项 | 结论 |
| 头文件和定义文件的名称是否合理？ | 是 | |
| 头文件和定义文件的目录结构是否合理？ | 是 | |
| 重要 | 头文件是否使用了 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常量取代宏常量？ | 无 | |
| 重要 | 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ | 否 |
| 是否误解了类中的const数据成员？因为const数据成员只在某个对象 生存期内是常量，而对于整个类而言却是可变的。 |
无 | |
| 函数设计 | ||
| 重要性 | 审查项 | 结论 |
| 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 是 | |
| 参数命名、顺序是否合理？ | 是 | |
| 参数的个数是否太多？ | 否 | |
| 是否使用类型和数目不确定的参数？ | 否 | |
| 是否省略了函数返回值的类型？ | 否 | |
| 函数名字与返回值类型在语义上是否冲突？ | 否 | |
| 重要 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得， 而错误标志用return语句返回。 |
否 |
| 重要 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 否 |
| 重要 | 使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在 的并且是一定要作出处理的。 |
否 |
| 重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 否 |
| 是否使用const提高函数的健壮性？const可以强制保护函数的参数、 返回值，甚至函数的定义体。“Use const whenever you need” |
无 | |
| 内存管理 | ||
| 重要性 | 审查项 | 结论 |
| 重要 | 用malloc或new申请内存之后，是否立即检查指针值是否为NULL？ （防止使用指针值为NULL的内存） |
否 |
| 重要 | 是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作 为右值使用） |
是 |
| 重要 | 数组或指针的下标是否越界？ | 否 |
| 重要 | 动态内存的申请与释放是否配对？（防止内存泄漏） | 是 |
| 重要 | 是否有效地处理了“内存耗尽”问题？ | 否 |
| 重要 | 是否修改“指向常量的指针”的内容？ | 否 |
| 重要 | 是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete 释放了内存之后，忘记将指针设置为NULL。 |
否 |
| 重要 | 是否将malloc/free 和 new/delete 混淆使用？ | 否 |
| 重要 | malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？ | 是 |
| 重要 | 在创建与释放动态对象数组时，new/delete的语句是否正确无误？ | 无 |
| 其它常见问题 | ||
| 重要性 | 审查项 | |
| 重要 | 数据类型问题： | |
| （１）变量的数据类型有错误吗？ | 否 | |
| （２）存在不同数据类型的赋值吗？ | 否 | |
| （３）存在不同数据类型的比较吗？ | 否 | |
| 重要 | 变量值问题： | |
| （１）变量的初始化或缺省值有错误吗？ | 否 | |
| （２）变量发生上溢或下溢吗？ | 否 | |
| （３）变量的精度够吗？ | 是 | |
| 重要 | 逻辑判断问题： | |
| （１）由于精度原因导致比较无效吗？ | 否 | |
| （２）表达式中的优先级有误吗？ | 否 | |
| （３）逻辑判断结果颠倒吗？ | 否 | |
| 重要 | 循环问题： | |
| （１）循环终止条件不正确吗？ | 否 | |
| （２）无法正常终止（死循环）吗？ | 否 | |
| （３）错误地修改循环变量吗？ | 否 | |
| （４）存在误差累积吗？ | 否 | |
| 重要 | 文件I/O问题： | |
| （１）对不存在的或者错误的文件进行操作吗？ | 否 | |
| （２）文件以不正确的方式打开吗？ | 无 | |
| （３）文件结束判断不正确吗？ | 否 | |
| （４）没有正确地关闭文件吗? | 否 | |
三、代码评价
本次审查的代码是我的结对伙伴章璐同学的数据结构课程设计程序，程序实现的是实现银行排号系统，主要功能是设置四个服务窗口，并随机产生客户到达时间以及办理业务时时长，并将客户安排到某一窗口办理业务，利用队列存储客户到达时间及办理业务时长信息。程序在vs2017中可以正常运行并且能够输出正确的结果并将其保存于txt文件中。
我看到代码的第一映像是该代码书写很工整，读起来很舒服，但是美中不足的是关于代码的注释比较少，让程序的可读性降低不少，以下是我对该程序代码的总结：
1.优点
- 代码整体布局美观，书写工整，缩进及断行很有规律
- 函数命名规范，足以说明该函数的作用，增强了代码的可读性
- 书写规范，没有在同一行中出现两个或两个以上的功能语句
- 结构清晰，将不同功能分为不同模块，便于阅读一后续修改
- 在程序运行结束之后能将队列置空释放内存空间
- 程序中不存在高难度或复杂度高的语句
2.不足
- 程序中对代码的注释过少，降低了代码的可读性
- 当if/else语句后只跟一个语句时缺少“{}”
- 将部分define语句以及全局变量定义放置于代码中间
- 部分变量名设置不规范，例如数组a1[]、整数k1等
3.个人总结
在本次结对伙伴之间互相审查代码作业过程中，我将我自己的代码与伙伴的代码进行了对比，发现了我的代码中存在着不少的不足，有很多地方可以向伙伴学习，例如代码的布局、缩进以及对一些细节的处理方面。通过本次作业，我也了解了一些伙伴的编程习惯和编程技巧，我也将尝试着适应这种编程习惯，增加我们之间的默契感，增强结对编程的效率。