| 博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
|---|---|
| 作业要求 | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10685 |
| 课程目标 | 熟悉一个“高质量”软件的开发过程 |
| 作业目标 | 结对编程练习 |
一、作业题目
我们在刚开始上课的时候介绍过一个小学四则运算自动生成程序的例子，请实现它，要求：
能够自动生成四则运算练习题
可以定制题目数量
用户可以选择运算符
用户设置最大数（如十以内、百以内等）
用户选择是否有括号、是否有小数
用户选择输出方式（如输出到文件、打印机等）
最好能提供图形用户界面（根据自己能力选做，以完成上述功能为主）
二、任务分配
驾驶员:潘室泽
负责全部代码编写工作，实现题目所需要的功能，将代码上传到Github代码托管系统中。
领航员:姜智文
辅助驾驶员完成题目，并且为关键函数选用合适的覆盖标准设计测试用例，并编写代码进行单元自动测试；利用代码检查表对驾驶员的本次工作进行评价，并同时填写PSP 0.1工作记录表，本次工作完成500字以上的总结。
三、程序测试
初步测试:
程序出现逻辑错误，与潘室泽进行沟通，重新编写程序。
四、代码审查
| 功能模块名称 | 四则运算 | ||
| 审查人 | 姜智文 | 审查日期 | 2020.04.27 |
| 代码名称 | 四则运算 | 代码作者 | 潘室泽 |
| 文件结构 | |||
| 重要性 | 审查项 | 结论 | |
| 头文件和定义文件的名称是否合理？ | 是 | ||
| 头文件和定义文件的目录结构是否合理？ | 是 | ||
| 版权和版本声明是否完整？ | 无 | ||
| 重要 | 头文件是否使用了 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问题： | ||
| （１）对不存在的或者错误的文件进行操作吗？ | 否 | ||
| （２）文件以不正确的方式打开吗？ | 否 | ||
| （３）文件结束判断不正确吗？ | 否 | ||
| （４）没有正确地关闭文件吗? | 否 | ||
五、工作记录表
| 项目 | 预计 | 实际 |
|---|---|---|
| 设计时间 | 2h | 2h |
| 编码时间 | 10h | 10h |
| 测试时间 | 2h | 3h |
| 代码行数 | 300 | 214 |
| 测试代码行数 | 300 | 214 |
| 错误数量 | 2 | 2 |
| 错误修复时间 | 2h | 2h |
| 开发总时间 | 3day | 3day |
总结
(1)自我评价
我是这次作业的领航员，负责对代码进行测试，以及对代码进行审查，对工作记录进行总结。在整个结对作业过程中，这次与潘室泽合作的很愉快，在与潘室泽讨论之后就开始着手进行。在编程过程中及时指出我的失误，在我遇到问题时交换自己的想法，让程序更加完善，也让我从中学到了很多。最后我将测试代码做的详细以求能够覆盖程序的基本功能。
(2)驾驶员评价
潘室泽担任驾驶人角色，鉴于其编码能力较强，所以他对题目进行编码。虽然潘室泽编码能力较强，但是可能可能存在一些小问题导致程序出现了逻辑错误，与他沟通时，他能及时进行反馈，并且很快更正，并且在编程过程中改正了一些以前不好的编程习惯，变量和函数的命名尽量做到规范，在必要的地方添加注释注明代码的含义及功能，增加程序的可读性。与他合作过程中，收获了很多，对自己的编程思想也提高了很多。
(3)作业评价
因为受到疫情的影响，结对编程只能通过聊天app完成，虽然不能面对面进行沟通，但是我们之间的互动与合作还是非常高效，很顺利地完成了此次结对作业。
这次与其说是完成了一次结对作业，更不如说是完成了一个小项目，因为与自己单独编写不同，要时刻与伙伴进行沟通，交换思路与想法。我认为这次合作比较成功的，在进行各种改正与审查之后，实现了题目中提出的要求，并且能够产生正确的结果。