软件工程（2019）结对编程第二次作业
题目要求
我们在刚开始上课的时候介绍过一个小学四则运算自动生成程序的例子，请实现它，要求：
- 能够自动生成四则运算练习题
- 可以定制题目数量
- 用户可以选择运算符
- 用户设置最大数（如十以内、百以内等）
- 用户选择是否有括号、是否有小数
- 用户选择输出方式（如输出到文件、打印机等）
- 最好能提供图形用户界面（根据自己能力选做，以完成上述功能为主）
任务分配
驾驶员：林亚超
领航员：单文聪
本次我们两个人并未完全采用驾驶员与领航员的工作模式，而是采用分工合作的方式完成的本次作业，我负责随机四则运算式的生成，林亚超同学负责其余的所有功能，相比较而言，驾驶员还是实现了代码的大部分功能，同时对于函数单元测试模块，我们也是采取分工完成，我负责逆波兰表达式的生成函数的单元测试，林亚超同学负责计算结果函数的单元测试。
- 程序完整代码coding.net
代码审查表
| 功能模块名称 | 四则运算自动生成程序 | ||
| 审查人 | 单文聪 | 审查日期 | 2019.4.30 |
| 代码名称 | 四则运算自动生成程序 | 代码作者 | 林亚超 |
| 文件结构 | |||
| 重要性 | 审查项 | 结论 | |
| 头文件和定义文件的名称是否合理？ | 是 | ||
| 头文件和定义文件的目录结构是否合理？ | 是 | ||
| 版权和版本声明是否完整？ | 否 | ||
| 重要 | 头文件是否使用了 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？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。 | 未使用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问题： | ||
| （１）对不存在的或者错误的文件进行操作吗？ | 无 | ||
| （２）文件以不正确的方式打开吗？ | 没有 | ||
| （３）文件结束判断不正确吗？ | 正确 | ||
| （４）没有正确地关闭文件吗? | 正确 | ||
代码运行结果
-
整数，带括号，四个运算符，不写入文件
-
小数，带括号，四个运算符，写入文件
-
文件内容
-
整数，不带括号，三个运算符，写入文件
-
文件内容
-
小数，不带括号，三个运算符，不写入文件
-
图形化界面实现
代码单元测试
对代码中的两个函数Rpn_expression()和Calculate()进行单元测试（因Calculate()函数的单元测试是林亚超同学完成的，故此函数的单元测试部分将在他的博客中展示）。
此次单元测试采用条件覆盖。
- Rpn_expression()函数（生成逆波兰表达式）代码：
float* Rpn_expression(float*arr)
{
stack<float> s1; //存运算符
stack<float> s2; //存数
s1.push(1000000); // 栈底，是最低优先级
float* a = arr;
float ch_s1; //接收s1的栈顶元素返回值
for (; *a != -1; a++)
{
switch ((int)*a)
{
//左括号符号直接入栈
case 1000005: //'('
s1.push(1000005); break;
//把和距离右括号最近的左括号之间的字符依次出栈，送入S2,将左括号弹出
case 1000006: //')'
while (s1.top() != 1000005)
{
ch_s1 = s1.top();
s1.pop();
s2.push(ch_s1);
}
s1.pop();
break;
//遇下列运算符，则分情况讨论：
//1.若当前栈s1的栈顶元素是'('，则当前运算符直接压入栈s1；
//2.否则，将当前运算符与栈s1的栈顶元素比较，若优先级较栈顶元素大，则直接压入栈s1中,
// 否则将s1栈顶元素弹出，并压入栈s2中，直到栈顶运算符的优先级别低于当前运算符，然后再将当前运算符压入栈s1中
case 1000001: // '+'
case 1000002:// '-'
while (s1.top() != 1000000)
{
if (s1.top() == 1000005)
break;
ch_s1 = s1.top();
s1.pop();
s2.push(ch_s1);
}
s1.push(*a);
break;
case 1000003: //'*'
case 1000004: //'/'
while (s1.top() != 1000001 && s1.top() != 1000002 && s1.top() != 1000000)
{
if (s1.top() == 1000005)
{
break;
}
else
{
ch_s1 = s1.top();
s1.pop();
s2.push(ch_s1);
}
}
s1.push(*a);
break;
/*如果*a在0-9之间，判断*(a+1）是否在0-9之间，如果是，将*a存在数组trans里，依次判断以后的*(a+i);*/
/*用atof函数以trans为参数将字符串转化为浮点数，并存入栈s2;否则直接存入s2栈*/
default:
{
s2.push(*a);
break;
}
}
}
while (!s1.empty() && s1.top() != 1000000) //如果s1非空，则剩余元素全部入栈s2
{
ch_s1 = s1.top();
s1.pop();
s2.push(ch_s1);
}
int length = s2.size();
float* reverse;
reverse = (float*)malloc(sizeof(float)*length);
reverse[length] = '\0';
Number_print = length;
for (int i = length - 1; i >= 0; i--)
{
reverse[i] = s2.top();
s2.pop();
}
return reverse;
}
- Rpn_expression()函数（生成逆波兰表达式）单元测试模块代码如下：
TEST_METHOD(TestMethod1)
{
//1+2*4
// TODO: 在此输入测试代码
int i;
float *array;
float arr[] = { 1,1000001,2,1000003,4,-1 };
float Array[30]= { 1,2,4,1000003,1000001};
array = Rpn_expression(arr);
for (int i = 0; i < Number_print; i++)
Assert::AreEqual(Array[i], array[i]);
Number_print = 0;
}
TEST_METHOD(TestMethod2)
{
//1*5+9
// TODO: 在此输入测试代码
int i;
float *array;
float arr[] = { 1,1000003,5,1000001,9,-1 };
float Array[30] = { 1,5,1000003,9,1000001 };
array = Rpn_expression(arr);
for (int i = 0; i < Number_print; i++)
Assert::AreEqual(Array[i], array[i]);
Number_print = 0;
}
TEST_METHOD(TestMethod3)
{
//(1-5)*9+6
// TODO: 在此输入测试代码
int i;
float test[30];
float *array;
float arr[] = { 1000005,1,1000002,5,1000006,1000003,9,1000001,6,-1 };
float Array[30] = { 1,5,1000002,9,1000003,6,1000001 };
array = Rpn_expression(arr);
for (int i = 0; i < Number_print; i++)
Assert::AreEqual(Array[i], array[i]);
Number_print = 0;
}
TEST_METHOD(TestMethod4)
{
//1-9/6+(5-8)
// TODO: 在此输入测试代码
int i;
float test[30];
float *array;
float arr[] = { 1,1000002,9,1000004,6,1000001,1000005,5,1000002,8,1000006,-1};
float Array[30] = { 1,9,6,1000004,1000002,5,8,1000002,1000001 };
array = Rpn_expression(arr);
for (int i = 0; i < Number_print; i++)
Assert::AreEqual(Array[i], array[i]);
}
- 测试结果：
四则运算表达式生成功能介绍
因为我负责了四则运算表达式的生成，所以在此对该部分代码部分函数进行介绍。
因四则运算表达式需要可以生成小数和整数，故设置两个函数，来生成随机整数和小数。用时间做随机数种子，可获得随机整数，整数除1.02即可获得随机小数
- 随机小数生成
float point(int n) //小数生成器
{
float random;
random = (rand() % n) / 1.02;
return random;
}
- 随机整数生成
int no_point(int n) //整数生成器
{
int random;
random = rand() % n;
return random;
}
四则运算表达式中还要可以添加括号，所以先写一个函数，让他可以生成四则运算式，但是不带括号，再通过另一个函数进行插入括号操作。当一个算式没有括号时，此时把这个表达式看作一个数组，数字和符号相应进入数组，显而易见，数组序号为奇数时为符号，数组序号为偶数时为数字，应用此种方式并配合随机数选择运算符，来生成随机四则表达式。括号插入时，也是通过随机数选择该表达式是否要插入括号，以及括号插在什么位置，在括号插入的位置将数组向后移即可实现带括号的四则运算式。
- 四则运算表达式的生成
void create(int num,int n,int Num,int max) //生成随机运算式
{
int i;
int j;
int bj = 0;
int Decimal = 0;
for (i = 0; i < n; i++)
{
if (symbol[i] == 5)
Brackets++;
if (symbol[i] == 6)
Decimal++;
}
if (Decimal == 1)
n--;
if (Brackets == 1)
n--;
for (j = 0; j < num; j++)
{
if (Decimal == 0)
{
for (i = 0; i <= Num * 2 - 2;) //生成数字
{
array[i] = no_point(max);
i = i + 2;
}
}
else
{
for (i = 0; i <= Num * 2 - 2;) //生成数字
{
array[i] = point(max);
i = i + 2;
}
}
for (i = 1; i <= Num * 2 - 3;) //生成符号
{
array[i] = symbol[no_point(n)]+1000000;
i = i + 2;
}
if (Brackets == 1)
AddBrackets(Num); //插入括号
Print(Num, Decimal, max, Brackets); //输出
}
}
- 括号插入
void AddBrackets(int Num) //插入括号
{
int s;
int place;
number = Num * 2-1;
s = Num * 2 - 4; //最远插括号的位置
s++;
if (rand() % 2 == 0)
{
BJ = 1;
place = rand() % s;
if (place % 2 == 1)
place++;
Gohome(place, Num); //数组向后移动一位
place += 4;
Gohome(place, Num);
}
}
-
代码实现结果
-
带括号，小数，四个运算符
-
不带括号，整数，三个运算符
-
表达式生成的完整代码coding.net
总结
虽然本次结对编程并未完全采取领航员和驾驶员的模式，但是我们两个人的工作模式也是近似于这个模式的，领航员负责四则运算表达式的生成功能，和一个关键函数的单元测试模块，驾驶员负责其余代码功能的实现，和另外一个关键函数的单元测试模块。虽然这是我们第一次合作写代码，但是现在看来我们还是很有默契的，我写的四则运算部分的代码可以很好的和他的逆波兰表达式的生成部分代码连接到一起。
对于本次代码的除图形化以外功能的实现和关键函数的单元模块测试，我们一共用了两天时间，第一天实现了随机生成四则运算式，算式可以转化为逆波兰表达式，并计算出结果，但是结果还是稍微有些问题，第一天的工作结束。第二天我们先进行了算式结果的修正，对程序中出现的BUG进行更改，一个上午完成了BUG的修改，可以算出正确的数据了，下午我们完成了文件的写入和关键函数的单元模块测试，完成这些以后，林亚超同学又用了一段时间完成了图形化操作界面，本次结对作业完成。
本次合作很愉快，可以看出林亚超同学的代码写的很严谨，注释清晰，变量以及函数的命名，让人一看就能知道这个变量或者函数的功能是什么，这一点是很值得我去学习的，下次再写代码的时候我会注意变量以及函数的命名问题以及注释问题，让自己养成良好的习惯，这也方便以后别人读我的代码，一举两得。
本次结对编程让我学到了很多，我会总结出自己在本次结对编程中的收获，做的好的地方继续提升，做的不好的地方加以改正，为自己成为一个合格的软件工程师做铺垫。
