软件工程结对编程第二次作业
小学四则运算自动生成器
题目要求
- 能够自动生成四则运算练习题
- 可以定制题目数量
- 用户可以选择运算符
- 用户设置最大数（如十以内、百以内等）
- 用户选择是否有括号、是否有小数
- 用户选择输出方式（如输出到文件、打印机等）
- 最好能提供图形用户界面（根据自己能力选做，以完成上述功能为主)
成员分工
- 驾驶员：姚双合
- 领航员：孙治朝
代码地址
代码复审
| 功能模块名称 | 小学四则运算自动生成器 | ||
| 审查人 | 孙治朝 | 审查日期 | 2019年5月3日 |
| 代码名称 | Calculate.cpp | 代码作者 | 姚双合 |
| 文件结构 | |||
| 重要性 | 审查项 | 结论 | |
| 头文件和定义文件的名称是否合理？ | 合理 | ||
| 头文件和定义文件的目录结构是否合理？ | 合理 | ||
| 版权和版本声明是否完整？ | 完整 | ||
| 重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | 用到了 | |
| 头文件中是否只存放“声明”而不存放“定义” | 否 | ||
| 程序的版式 | |||
| 重要性 | 审查项 | 结论 | |
| 空行是否得体？ | 是 函数块之间都有空行 | ||
| 代码行内的空格是否得体？ | 是 | ||
| 长行拆分是否得体？ | 没有出现长行 | ||
| “{” 和 “}” 是否各占一行并且对齐于同一列？ | 是 | ||
| 重要 | 一行代码是否只做一件事？如只定义一个变量，只写一条语句。 | 是 | |
| 重要 | If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。 | 是 不论执行语句多少都要加 “{}” | |
| 重要 | 在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？ | 是 | |
| 重要 | 注释是否有错误或者可能导致误解？ | 没有，注释非常清晰 | |
| 重要 | 类结构的public, protected, private顺序是否在所有的程序中保持一致？ | 一致 | |
| 命名规则 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致？ | 是 | |
| 标识符是否直观且可以拼读？ | 是 类中定义的变量非常明确 | ||
| 标识符的长度应当符合“min-length && max-information”原则？ | 是 | ||
| 重要 | 程序中是否出现相同的局部变量和全部变量？ | 没有出现 | |
| 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？ | 是 | ||
| 静态变量、全局变量、类的成员变量是否加前缀？ | 是 只是用到了全局变量 | ||
| 表达式与基本语句 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？ | 是 分级加了括号 | |
| 是否编写太复杂或者多用途的复合表达式？ | 否 | ||
| 重要 | 是否将复合表达式与“真正的数学表达式”混淆？ | 否 | |
| 重要 | 是否用隐含错误的方式写if语句? 例如 | ||
| （1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 否 直接用“！”判断布尔变量 | ||
| （2）将浮点变量用“==”或“！=”与任何数字比较。 | 否 | ||
| （3）将指针变量用“==”或“！=”与NULL比较。 | 是 打开文件时，文件指针与NULL比较 | ||
| 如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判 | |||
| 断移到循环体的外面？ | 否 | ||
| 重要 | Case语句的结尾是否忘了加break？ | 都加了break | |
| 重要 | 是否忘记写switch的default分支？ | 否 | |
| 重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 没有使用goto语句 | |
| 常量 | |||
| 重要性 | 审查项 | 结论 | |
| 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？ | 是 比如“question”表示产生的算式结果 | ||
| 在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的语句是否正确无误？ | 未使用 | |
| 其它常见问题 | |||
| 重要性 | 审查项 | 结论 | |
| 重要 | 数据类型问题： | ||
| （１）变量的数据类型有错误吗？ | 没有 | ||
| （２）存在不同数据类型的赋值吗？ | 存在 double类型向float类型转化 | ||
| （３）存在不同数据类型的比较吗？ | 不存在 | ||
| 重要 | 变量值问题： | ||
| （１）变量的初始化或缺省值有错误吗？ | 没有 | ||
| （２）变量发生上溢或下溢吗？ | 不发生 | ||
| （３）变量的精度够吗？ | 够 从double类型到float类型，有精度损失 | ||
| 重要 | 逻辑判断问题： | ||
| （１）由于精度原因导致比较无效吗？ | 没有 | ||
| （２）表达式中的优先级有误吗？ | 没有 | ||
| （３）逻辑判断结果颠倒吗？ | 没有 | ||
| 重要 | 循环问题： | ||
| （１）循环终止条件不正确吗？ | 正确 | ||
| （２）无法正常终止（死循环）吗？ | 不存在 | ||
| （３）错误地修改循环变量吗？ | 否 | ||
| （４）存在误差累积吗？ | 不存在 | ||
| 重要 | 错误处理问题： | ||
| （１）忘记进行错误处理吗？ | 没有进行空值处理 指正未进行空处理 | ||
| （２）错误处理程序块一直没有机会被运行？ | 否 | ||
| （３）错误处理程序块本身就有毛病吗？如报告的错误与实际错误不一致，处理方式不正确等等。 | 没有 | ||
| （４）错误处理程序块是“马后炮”吗？如在被它被调用之前软件已经出错。 | 不是 | ||
单元测试
程序中产生的运算等式时，无论是其中的计算的数字、运算符的选择还是括号所加的位置，都是用随机数产生，这也就导致了在做单元测试是无法正确地给期望值赋值。这里所做的单元测试来检测类中返回值为bool型的函数。其中，对于函数bool IsRight_Parenthesis(char P_temp)做了条件/判断覆盖。
- 单元测试代码
#include "stdafx.h"
#include "CppUnitTest.h"
#include "..\结对2\Calculator.h"
using namespace Microsoft::VisualStudio::CppUnitTestFramework;
namespace UnitTest1
{
TEST_CLASS(UnitTest1)
{
public:
TEST_METHOD(TestMethod1)
{
Calculator* calu = new Calculator();
Assert::AreEqual(true, calu->IsRight_Parenthesis('y'));
}
TEST_METHOD(TestMethod4)
{
Calculator* calu = new Calculator();
Assert::AreEqual(false, calu->IsRight_Parenthesis('SS'));
}
TEST_METHOD(TestMethod5)
{
Calculator* calu = new Calculator();
Assert::AreEqual(true, calu->IsRight_Parenthesis('N'));
}
TEST_METHOD(TestMethod2)
{
Calculator* calu = new Calculator();
Assert::AreEqual(false, calu->IsRight_Decimal('f'));
}
TEST_METHOD(TestMethod3)
{
Calculator* calu = new Calculator();
Assert::AreEqual(true, calu->IsRight_File('Y'));
}
};
}
单元测试结果如图所示。
产生某一种算式如下图：
-
选择有括号且是小数的算式
-
产生有括号且是整数，同时保存至文档
对驾驶员工作的评价
我们选的题目时四则运算生成器，题目看着简单，但是在编写代码的工作量还是非常的大，因此驾驶员完成本次作业非常的辛苦。由于是假期嘛，人都有懒惰情绪，驾驶员和我从确定题目到最后由驾驶员编写完代码所花费的时间非常长，但这些都很正常，我们也能相互理解。
现在来评价一下代码吧。姚双合有了第一次结对编程作业的经验，这次写代码非常的谨慎。不仅将自己原来好的习惯继续保持了下来，还把自己之前不好的习惯进行了最大化的改正。比如：在for循环体内或者if判断体内，即使只执行一条语句，他也能够按照规范加上“{}”，并且“{”和“}”各占一行，这让程序很有结构性，阅读起来也非常容易。总结一下代码优点：
- 注释加的非常得体；对于关键函数，注释简明扼要，没有冗余。
- 代码结构有较好的层次感；函数与函数之间都加了空行以示区分。
- 代码运行效率高，没有写复杂度比较大的函数。
代码功能以及代码规范还是有不足之处：
- 没有实现图形化界面显示。
- 用到了类，但是并没有更生层次的应用，比如函数重载。
总结
首先，由于我和姚双合能力的原因，这次作业仅仅完成了最基本的要求，并没有实现图形化界面，这也略显遗憾吧。但是我们约定，以后找机会把这个四则运算自动生成器做一次整体升级，使其能够得到大众化使用。在姚双合编写代码之前，我们有足够的沟通，同时也对编程过程中可能出现的问题进行了预处理。但是计划赶不上变化，在完成整个作业的过程中，我们俩还是遇到了一些没有预想到的问题。其中我们遇到最大的问题就是如何随机地加括号。左括号的添加相对比较简单，但是右括号随机确定时，有可能出现“(3+4/2)=”或者“3+(4)/2=”等各种错误情况。刚开始我们的想法是，先生成算式，然后再去加括号，然而在做的过程中右括号不太好控制。最终我们决定一边生成算式，一边加括号，这样很大程度上提升了程序的效率。
我认为这次和姚双合结对合作非常成功。我们通过合作完成了第一个真正意义上的团队项目，各自都体验了如何在团队中（虽然只有两个人）高效地工作，如何和队友快速沟通等等。同时各自也学到了对方的有点、发现了自己的不足之处。比如姚双合对于每一个语法点扣得都很细，从而减少了bug的产生。这就是我应该学习的东西，对于一个语法点，往大了说就是对于知识，不能说“大概”，应该是准确地掌握。在讨论如何加右括号的过程中，我感觉右括号伪随机一下就好，不用太认真。但是姚双合始终坚持要做到右括号也要随机地加。最终在我们俩的共同努力下，左右括号都实现了随机添加。对于自己所做的每一件事，只有投入了百分百的努力，你才有可能把这件事做好。
这次合作很愉快！强化了彼此之间的默契度。
