| 博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
|---|---|
| 作业要求 | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10685 |
| 课程目标 | 熟悉一个“高质量”软件的开发过程 |
| 作业目标 | 结对编程练习 |
一、题目要求
-
题目1：
-
我们在刚开始上课的时候介绍过一个小学四则运算自动生成程序的例子，请实现它，要求：
- 能够自动生成四则运算练习题
- 可以定制题目数量
- 用户可以选择运算符
- 用户设置最大数（如十以内、百以内等）
- 用户选择是否有括号、是否有小数
- 用户选择输出方式（如输出到文件、打印机等）
- 最好能提供图形用户界面（根据自己能力选做，以完成上述功能为主）
二、任务分工
驾驶员：张号，负责完成代码的编写工作，并对同伴在本次编程工作中起到的作用给出客观评价；
领航员：杨莹莹，辅助驾驶员完成代码，设计单元测试用例，并完成代码审查工作，最后对同伴做出评价。
三、程序部分
1.窗口初始化设置
2.程序生成文件结果
四、代码审查部分
代码审查表
| 功能模块名称 | 四则运算自动生成 | |||
| 审查人 | 杨莹莹 | 审查日期 | 2020/4/28 | |
| 代码名称 | Form1.cs | 代码作者 | 张号 | |
| 文件结构 | ||||
| 重要性 | 审查项 | 结论 | ||
| 头文件和定义文件的名称是否合理？ | 是 | |||
| 头文件和定义文件的目录结构是否合理？ | 是 | |||
| 版权和版本声明是否完整？ | 是 | |||
| 重要 | 头文件是否使用了 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问题： | |||
| （１）对不存在的或者错误的文件进行操作吗？ | 否 | |||
| （２）文件以不正确的方式打开吗？ | 否 | |||
| （３）文件结束判断不正确吗？ | 否 | |||
| （４）没有正确地关闭文件吗? | 否 | |||
五、单元测试
此次选择对四则运算式随机生成函数CreateTxt()部分进行设计测试用例
自动测试分析结果
| 序号 | 随机数（b） | 有无括号（ISelection） | 左括号位置（left） | 右括号位置（right） | 随机运算符（option） | 理论输出 | 实际输出 |
|---|---|---|---|---|---|---|---|
| 1 | 3.14 | 有（1） | 0 | 2 | * | (3.14 * 3.14 * 3.14) * 3.14 = | (3.14 * 3.14 * 3.14) * 3.14 = |
| 2 | 6 | 无（0） | / | / | + | 6 + 6 + 6 + 6 = | 6 + 6 + 6 + 6 = |
| 3 | 9.9 | 有（1） | 1 | 3 | ÷ | 9.9 ÷ (9.9 ÷ 9.9 ÷ 9.9) = | 9.9 ÷ (9.9 ÷ 9.9 ÷ 9.9) = |
单元测试工作记录表
| 项目 | 记录结果 |
|---|---|
| 日期 | 2020/4/28 |
| 开始时间 | 13:30 |
| 结束时间 | 14:00 |
| 源代码编码行数 | 464（不包含系统生成的代码） |
| 测试代码编码行数 | 201 |
| 错误数量 | 1 |
| 错误1 | 测试对比结果不正确 |
| 错误1原因 | 使用了错误的C#断言函数StringAssert.Matches，改用Assert.AreEqual |
| 错误1修改时间 | 5分钟 |
六、伙伴评价及项目总结
首先，非常开心能和张号同学结对完成此次项目。在项目初期设计阶段，因为要求最好能提供图形用户界面，而在此之前我们俩都没有学习过这方面的内容，但是张号同学的学习能力与自我管理能力都很强，并没有因为这个放弃。而是选择了C#语言进行整个程序的编写，从头学习C# WinForm界面设计（在此推荐C#教程）。并且在很短的时间里，整个用户界面已经初具规模。在代码规范上，也遵从着他一直以来良好的代码编写习惯。代码结构清晰，可读性很强。思考问题也很有方法，总是能找出现有的最优解。后期，我们俩开始商量四则运算随机生成算法的实现。我们也尝试互换身份，进行代码的编写。在张号同学作为领航员的过程中，他给我提出了很多种不同的算法途径，当我遇到有一些自己感觉行不通的办法时，也会主动与他探讨询问。而张号同学每次一语中的，给了我很多新思路。因此最终完成了这此的结对作业。我也从他身上学到了许多优秀的品质，对于问题、困难，不选择放弃，而是冷静思考选择出最优的解决方案。在此也很感谢张号同学这次的辛苦付出。希望以后还能有机会一起做项目，一起学习进步。虽然项目最后顺利完成了，但是也有一些遗憾的地方，心里预设的有些增加功能没有完全实现。由于时间原因，没能生成随机四则运算式的同步答案。但是自己也有去了解到可以用逆波兰表达式存储字符串，最后计算表达式的值。但是这样子，代码运行效率就下降了，或许还能在生成随机四则运算式的同时就计算出结果并写入文件。希望后面有时间能好好研究，实现这个功能。
七、项目工作记录表
| 项目 | 预计 | 实际 |
|---|---|---|
| 设计时间 | 1h | 30min |
| 编码时间 | 4h | 4h |
| 测试时间 | 1h | 30min |
| 代码行数 | 400 | 464（不包含系统生成的代码） |
| 测试代码行数 | 150 | 201 |
| 错误数量 | 2 | 2 |
| 错误修复时间 | 5min | 5min |
| 开发总时间 | 5h | 6h |