软件工程第三次作业
| 博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
|---|---|
| 作业要求 | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10616 |
| 课程目标 | 熟悉一个“高质量”软件的开发过程 |
| 作业目标 | 熟悉代码规范及结对互审 |
伙伴代码Github地址
审查表
| 功能模块名称 | 设计一个多边形类 | |||
| 审查人 | 刘军杰 | 审查日期 | 2020/4/15 | |
| 代码名称 | 设计一个多边形类 | 代码作者 | 蔡超 | |
| 文件结构 | ||||
| 序号 | 重要性 | 审查项 | 结论 | |
| 1 | 重要 | 头文件和定义文件的名称是否合理？ | 是 | |
| 2 | 头文件和定义文件的目录结构是否合理？ | 是 | ||
| 3 | 版权和版本声明是否完整？ | 是 | ||
| 4 | 头文件是否使用了 ifndef/define/endif 预处理块? | 是 | ||
| 5 | 头文件中是否只存放“声明”而不存放“定义” | 是 | ||
| 程序的版式 | ||||
| 6 | 不重要 | 空行是否得体？ | 是 | |
| 7 | 代码行内的空格是否得体？ | 否 | ||
| 8 | 长行拆分是否得体？ | 是 | ||
| 9 | “{” 和 “}” 是否各占一行并且对齐于同一列？ | 否 | ||
| 10 | 重要 | 一行代码是否只做一件事？如只定义一个变量，只写一条语句。 | 是 | |
| 11 | If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。 | 是 | ||
| 12 | 在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？ | 是 | ||
| 13 | 注释是否有错误或者可能导致误解？ | 否 | ||
| 命名规则 | ||||
| 14 | 重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致？ | 是 | |
| 15 | 不重要 | 标识符是否直观且可以拼读？ | 是 | |
| 16 | 标识符的长度应当符合“min-length && max-information”原则？ | 是 | ||
| 17 | 重要 | 程序中是否出现相同的局部变量和全部变量？ | 否 | |
| 18 | 不重要 | 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ | 是 | |
| 19 | 静态变量、全局变量、类的成员变量是否加前缀？ | 否 | ||
| 表达式与基本语句 | ||||
| 20 | 重要 | 如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？ | 是 | |
| 21 | 不重要 | 是否编写太复杂或者多用途的复合表达式？ | 否 | |
| 22 | 重要 | 是否将复合表达式与“真正的数学表达式”混淆？ | 否 | |
| 23 | 不重要 | 是否用隐含错误的方式写if语句? 例如 | ||
| （1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 否 | |||
| （2）将浮点变量用“==”或“！=”与任何数字比较。 | 否 | |||
| （3）将指针变量用“==”或“！=”与NULL比较。 | 否 | |||
| 24 | 如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体外面 | 是 | ||
| 常量 | ||||
| 25 | 不重要 | 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ | 是 | |
| 26 | 在C++ 程序中，是否用const常量取代宏常量？ | 否 | ||
| 27 | 重要 | 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ | 是 | |
| 函数设计 | ||||
| 28 | 不重要 | 参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。 | 是 | |
| 29 | 参数命名、顺序是否合理？ | 是 | ||
| 30 | 参数的个数是否太多？ | 否 | ||
| 31 | 是否使用类型和数目不确定的参数？ | 否 | ||
| 32 | 是否省略了函数返回值的类型？ | 否 | ||
| 33 | 函数名字与返回值类型在语义上是否冲突？ | 否 | ||
| 34 | 重要 | 是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。 | 否 | |
| 35 | 在函数体的“入口处”，是否用assert对参数的有效性进行检查？ | 否 | ||
| 36 | return语句是否返回指向“栈内存”的“指针”或者“引用”？ | 否 | ||
| 37 | 不重要 | 是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need” | 是 | |
| 内存管理 | ||||
| 38 | 重要 | 用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存） | 是 | |
| 39 | 是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用） | 否 | ||
| 40 | 数组或指针的下标是否越界？ | 否 | ||
| 41 | 动态内存的申请与释放是否配对？（防止内存泄漏） | 否 | ||
| 42 | 是否有效地处理了“内存耗尽”问题？ | 是 | ||
| 43 | 是否修改“指向常量的指针”的内容？ | 否 | ||
| 44 | 是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。 | 否 | ||
| 45 | 是否将malloc/free 和 new/delete 混淆使用？ | 否 | ||
| 46 | malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？ | 是 | ||
| 47 | 在创建与释放动态对象数组时，new/delete的语句是否正确无误？ | 是 | ||
| 类的构造函数、析构函数和赋值函数 | ||||
| 48 | 重要 | 赋值函数一般分四个步骤： | ||
| （1）检查自赋值； | 是 | |||
| （2）释放原有内存资源； | 是 | |||
| （3）分配新的内存资源，并复制内容； | 是 | |||
| 其它常见问题 | ||||
| 49 | 重要 | 数据类型问题： | ||
| （１）变量的数据类型有错误吗？ | 否 | |||
| （２）存在不同数据类型的赋值吗？ | 否 | |||
| （３）存在不同数据类型的比较吗？ | 否 | |||
| 50 | 重要 | 变量值问题： | ||
| （１）变量的初始化或缺省值有错误吗？ | 否 | |||
| （２）变量发生上溢或下溢吗？ | 否 | |||
| （３）变量的精度够吗？ | 是 | |||
| 51 | 重要 | 逻辑判断问题： | ||
| （１）由于精度原因导致比较无效吗？ | 否 | |||
| （２）表达式中的优先级有误吗？ | 否 | |||
| （３）逻辑判断结果颠倒吗？ | 否 | |||
| 52 | 重要 | 循环问题： | ||
| （１）循环终止条件不正确吗？ | 是 | |||
| （２）无法正常终止（死循环）吗？ | 否 | |||
| （３）错误地修改循环变量吗？ | 否 | |||
| （４）存在误差累积吗？ | 否 | |||
| 53 | 重要 | 错误处理问题： | ||
| （１）忘记进行错误处理吗？ | 否 | |||
| （２）错误处理程序块一直没有机会被运行？ | 否 | |||
| （３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。 | 否 | |||
| （４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。 | 否 | |||
| 54 | 重要 | 文件I/O问题： | ||
| （１）对不存在的或者错误的文件进行操作吗？ | 否 | |||
| （２）文件以不正确的方式打开吗？ | 否 | |||
| （３）文件结束判断不正确吗？ | 否 | |||
代码点评：
队友的这篇代码所实现的功能是设计一个多边形类。所实现的功能可能比较简单，但从中可以看出许多东西。我认为，整篇代码的思路还是很清晰的，本篇中使用了多个不同的类，每个类都有自己需要实现的功能。各个功能的类从取名到中间逻辑清晰，从排版上来看，能够清晰的看出代码的整体结构，{}和（）的对应正确，在排版这方面做得还算可以。代码使用的函数名和变量名都根据使用的含义进行定义，方便使用者阅读。但其中也存在着一些不足的方面，最大的不足就是缺少注释，注释太少，有些空行用的比较随性，代码总体看起来不是那么美观，有一些可以简化的地方写的过于冗长。
总体来说，这篇代码虽然有一些小缺陷，但总体还算不错，有许多地方值得自己学习，而且通过检查伙伴的代码，对自己也是起到一个促进的作用，在这个过程中，自己也要查阅相关资料，弥补自己的不足，从而使自己的代码质量有所提高。我之前再写代码时就比较随意，变量命名都没太注意，导致代码的可读性较低，在排版上也不规范，没有用过注释。在这次结对编程中我从同伴代码中检查出了一些错误，也学到了一些自己之前没注意到的东西，希望在以后我们的结对编程中我们还能继续加油，互相学习，给对方纠错，不断提升自己！！！
