软件工程（2019）结对编程第二次作业
1.题目要求
- 能够自动生成四则运算练习题
- 可以定制题目数量
- 用户可以选择运算符
- 用户设置最大数（如十以内、百以内等）
- 用户选择是否有括号、是否有小数
- 用户选择输出方式（如输出到文件、打印机等）
- 最好能提供图形用户界面（根据自己能力选做，以完成上述功能为主）
2.成员分工
- 驾驶员 张亚伟
- 领航员 蔺永康
3.代码地址
代码地址为：张亚伟代码
4.代码审查表
| 功能模块名称 | 小学四则运算自动生成器 | ||
| 审查人 | 蔺永康 | 审查日期 | 2019.05.04 |
| 代码名称 | main.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常量取代宏常量？ | 是 | ||
| 重要 | 如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？ | 是 | |
| 是否误解了类中的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的语句是否正确无误？ | 未使用 | |
| C++ 函数的高级特性 | |||
| 重要性 | 审查项 | 结论 | |
| 重载函数是否有二义性？ | 未使用 | ||
| 重要 | 是否混淆了成员函数的重载、覆盖与隐藏？ | 未使用 | |
| 运算符的重载是否符合制定的编程规范？ | 未使用 | ||
| 是否滥用内联函数？例如函数体内的代码比较长，函数体内出现循环。 | 未使用 | ||
| 重要 | 是否用内联函数取代了宏代码？ | 未使用 | |
| 类的构造函数、析构函数和赋值函数 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数： | ||
| （1）缺省的无参数构造函数； | 未使用 | ||
| （2）缺省的拷贝构造函数； | 未使用 | ||
| （3）缺省的析构函数； | 未使用 | ||
| （4）缺省的赋值函数。 | 未使用 | ||
| 重要 | 构造函数中是否遗漏了某些初始化工作？ | 未使用 | |
| 重要 | 是否正确地使用构造函数的初始化表？ | 未使用 | |
| 重要 | 析构函数中是否遗漏了某些清除工作？ | 未使用 | |
| 是否错写、错用了拷贝构造函数和赋值函数？ | 未使用 | ||
| 重要 | 赋值函数一般分四个步骤： | ||
| （1）检查自赋值； | 未使用 | ||
| （2）释放原有内存资源； | 未使用 | ||
| （3）分配新的内存资源，并复制内容； | 未使用 | ||
| （4）返回 *this。是否遗漏了重要步骤？ | 未使用 | ||
| 重要 | 是否正确地编写了派生类的构造函数、析构函数、赋值函数？ | 未使用 | |
| 注意事项： | |||
| （1）派生类不可能继承基类的构造函数、析构函数、赋值函数。 | 未使用 | ||
| （2）派生类的构造函数应在其初始化表里调用基类的构造函数。 | 未使用 | ||
| （3）基类与派生类的析构函数应该为虚（即加virtual关键字）。 | 未使用 | ||
| （4）在编写派生类的赋值函数时，注意不要忘记对基类的数据成员重新赋值 | 未使用 | ||
| 类的高级特性 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 是否违背了继承和组合的规则？ | ||
| （1）若在逻辑上B是A的“一种”，并且A的所有功能和属性对B而言都有意义，则允许B继承A的功能和属性。 | 未使用 | ||
| （2）若在逻辑上A是B的“一部分”（a part of），则不允许B从A派生，而是要用A和其它东西组合出B。 | 未使用 | ||
| 其它常见问题 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 数据类型问题： | ||
| （１）变量的数据类型有错误吗？ | 否 | ||
| （２）存在不同数据类型的赋值吗？ | 否 | ||
| （３）存在不同数据类型的比较吗？ | 否 | ||
| 重要 | 变量值问题： | ||
| （１）变量的初始化或缺省值有错误吗？ | 否 | ||
| （２）变量发生上溢或下溢吗？ | 否 | ||
| （３）变量的精度够吗？ | 均为整型 | ||
| 重要 | 逻辑判断问题： | ||
| （１）由于精度原因导致比较无效吗？ | 否 | ||
| （２）表达式中的优先级有误吗？ | 否 | ||
| （３）逻辑判断结果颠倒吗？ | 否 | ||
| 重要 | 循环问题： | ||
| （１）循环终止条件不正确吗？ | 否 | ||
| （２）无法正常终止（死循环）吗？ | 否 | ||
| （３）错误地修改循环变量吗？ | 否 | ||
| （４）存在误差累积吗？ | 否 | ||
| 重要 | 错误处理问题： | ||
| （１）忘记进行错误处理吗？ | 否 | ||
| （２）错误处理程序块一直没有机会被运行？ | 否 | ||
| （３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。 | 否 | ||
| （４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。 | 否 | ||
| 重要 | 文件I/O问题： | ||
| （１）对不存在的或者错误的文件进行操作吗？ | 否 | ||
| （２）文件以不正确的方式打开吗？ | 否 | ||
| （３）文件结束判断不正确吗？ | 否 | ||
| （４）没有正确地关闭文件吗? | 否 | ||
5.测试分析
在进行测试环节时，由于好多功能函数都是生成随机数，无法直接进行单元测试，所以我就选择一些特定的函数功能进行测试。
- 混合运算的测试
检测随机生成的混合运算式子有无重复与格式错误。
- 最大、最小数的测试
检测运算数字大小是否在所规定的范围内。
- 括号、小数的测试
检测括号匹配是否正确，以及小数的有无。
- 输出方式的测试
运算表达式输出到待打印的文件里。
6.对驾驶员工作的评价
在开始写这次作业之前，我们俩进行了明确的分工，张亚伟是驾驶员，我是领航员。驾驶员的主要任务是负责编写代码。而我们选择了小学生四则运算生成算法的实现，看这个题目的名字很简单，但实际操作起来却很繁琐，代码量很大，驾驶员的工作很重也很累。驾驶员还是选择了熟悉的C语言，选用VS2017操作平台，驾驶员负责主要代码的编写，我负责从旁协助。驾驶员很尽责任，虽然编写过程很长，很累，但他都坚持下来了，很值得点赞。
在整体编写前，驾驶员他做足了准备，先是查找了大量资料，然后又画了些流程图，想好了思路，然后我们一起讨论选择了最优的方案。在编写过程中，驾驶员很认真，也很有想法，大部分内容他都能够一气呵成，其中有问题的我们也能够想办法解决。编程结束之后，他主动会提出一些在编写过程中忽略掉的问题，想办法和我一起解决，也尝试自己解决。
人无完人，在这次工作中，驾驶员也存在一点小问题，就是代码的格式有些乱，看起来很不舒服，可能是代码太多的缘故吧，编写完成之后没精力再去优化整洁一下代码。希望驾驶员加油努力，每日进步。
总的来说，这个驾驶员很出色，他尽职尽责，为人和善，和他完成任务的期间很愉快，是一位很好的合作伙伴。
7.工作总结
严格意义上来说，这是我第一次当领航员，很激动也很害怕，激动是对未知事物的好奇，害怕是怕自己做不好，胆怯。在上课时，老师便讲过领航员这一角色，当时感觉应该很容易，随便就完成了。可当你真正当了之后你才发现，很难，很有挑战性。
刚开始，我们俩先确定了自己的任务。确定完任务以后，开始着手实现了。我们选择了四则运算生成算法，难度较第二个简单一些，之后我们就进行了实现。但由于我们俩能力的原因，我们只实现了基本的功能，对于用户窗口可视化界面我们没有办法去实现，这点很遗憾。
在编写过程中，也遇到了很多的问题，大部分能解决，不能解决的我们查找资料，参考网上的，最后，总算是把代码编写出来了。在我审查代码时，是一项坚巨的任务，在审查过程，我在阅读代码时，加深了我对代码的理解，提升了我的算法思想，知道有些地方该怎样改进。但在这过程中也发现了许多编写过程中的问题，比如，不认真，有些变量没用到，有些过程太复杂，原本只需一步便可出来，但我们用了多步，绕了好多弯。还有就是函数设计的不美观，格式有的很乱。多一些没用的空行什么的。在测试过程中，让我学会了如何去模块化整个代码程序，知道那些是中点突出的，那些只是辅助的。但我也是发现了许多问题，就是显示结果设计的不太好，有点繁琐。需要输入一下，才出来一道题，太费劲了。这些都是在审查过程中发现的。
总之，这次作业收获很大，首先和同伴一起合作去完成作业时，可以随时学习同伴的优点，取长补短，有利于自己的进步。然后加强了合作意识，懂得分工，加快任务的完成。最后和同伴培养了羁绊，真情难得嘛。
