软件工程第四次作业

博客信息	沈阳航空航天大学计算机学院2020软件工程作业
作业要求	https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10685
课程目标	熟悉一个“高质量”软件的开发过程
作业目标	结对编程练习

一. 题目要求

我们在刚开始上课的时候介绍过一个小学四则运算自动生成程序的例子，请实现它，要求：
(1) 能够自动生成四则运算练习题
(2) 可以定制题目数量
(3) 用户可以选择运算符
(4) 用户设置最大数（如十以内、百以内等）
(5) 用户选择是否有括号、是否有小数
(6) 用户选择输出方式（如输出到文件、打印机等）
(7) 最好能提供图形用户界面（根据自己能力选做，以完成上述功能为主）

二. 任务分配

驾驶员：陈郎朗，负责代码编写，对同伴做出客观评价。
领航员：刘佳迎，辅助驾驶员完成代码编写，给出意见，实现代码的单元测试，对同伴做出评价。

三. 代码测试结果

代码测试结果通过图形用户界面实现，界面图片如下：

代码测试生成运算练习题图片如下：

四. 代码审查表

功能模块名称	四则运算
文件结构
序号	重要性	审查项	结论
1	不重要	头文件和定义文件的名称是否合理？	是
2	不重要	头文件和定义文件的目录结构是否合理？	是
3	不重要	版权和版本声明是否完整？	无
4	重要	头文件是否使用了 ifndef/define/endif 预处理块?	无
5	不重要	头文件中是否只存放“声明”而不存放“定义”	是
程序的板式
序号	重要性	审查项	结论
6	不重要	空行是否得体？	是
7	不重要	代码行内的空格是否得体？	是
8	不重要	长行拆分是否得体？	否
9	不重要	“{” 和 “}” 是否各占一行并且对齐于同一列？	否
10	重要	一行代码是否只做一件事？如只定义一个变量，只写一条语句	是
11	重要	If、for、while、do等语句自占一行，不论执行语句多少都要加 “{}”。	否
12	重要	在定义变量（或参数）时，是否将修饰符 * 和 ＆ 紧靠变量名？注释是否清晰并且必要？	是
13	重要	注释是否有错误或者可能导致误解？	否
14	重要	类结构的public, protected, private顺序是否在所有的程序中保持一致？	无
命名规则
序号	重要性	审查项	结论
15	重要	命名规则是否与所采用的操作系统或开发工具的风格保持一致？	是
16	不重要	标识符是否直观且可以拼读？	是
17	不重要	标识符的长度应当符合“min-length && max-information”原则？	无
18	重要	程序中是否出现相同的局部变量和全部变量？	否
19	不重要	类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则？	是
20	不重要 静态变量、全局变量、类的成员变量是否加前缀？	否
表达式与基本语句
序号	重要性	审查项	结论
21	重要	如果代码行中的运算符比较多，是否已经用括号清楚地确定表达式的操作顺序？	无
22	不重要	是否编写太复杂或者多用途的复合表达式？	否
23	重要	是否将复合表达式与“真正的数学表达式”混淆？	否
24	重要	（1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。	无
25	重要	（2）将浮点变量用“==”或“！=”与任何数字比较。	无
26	重要	（3）将指针变量用“==”或“！=”与NULL比较。	无
27	不重要	如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体的外面？	否
28	重要	Case语句的结尾是否忘了加break？	否
29	重要	是否忘记写switch的default分支？	否
30	重要	使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。	无
常量
序号	重要性	审查项	结论
31	不重要	是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？	是
32	不重要	在C++ 程序中，是否用const常量取代宏常量？	无
33	重要	如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？	无
34	不重要	是否误解了类中的const数据成员？因为const数据成员只在某个对象	无
35	不重要	生存期内是常量，而对于整个类而言却是可变的。	无
函数设计
序号	重要性	审查项	结论
36	不重要	参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。	是
37	不重要	参数命名、顺序是否合理？	是
38	不重要	参数的个数是否太多？	否
39	不重要	是否使用类型和数目不确定的参数？	否
40	不重要	是否省略了函数返回值的类型？	否
41	不重要	函数名字与返回值类型在语义上是否冲突？	否
42	重要	是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。	否
43	重要	在函数体的“入口处”，是否用assert对参数的有效性进行检查？	无
44	重要	使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。	无
45	重要	return语句是否返回指向“栈内存”的“指针”或者“引用”？	否
46	不重要	是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need”	无
内存管理
序号	重要性	审查项	结论
47	重要	用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存）	无
48	重要	是否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用）	否
49	重要	数组或指针的下标是否越界？	否
50	重要	动态内存的申请与释放是否配对？（防止内存泄漏）	无
51	重要	是否有效地处理了“内存耗尽”问题？	无
52	重要	是否修改“指向常量的指针”的内容？	否
53	重要	是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。	无
54	重要	是否将malloc/free 和 new/delete 混淆使用？	无
55	重要	malloc语句是否正确无误？例如字节数是否正确？类型转换是否正 确？	无
56	重要	在创建与释放动态对象数组时，new/delete的语句是否正确无误？	无
C++函数的高级特性
序号	重要性	审查项	结论
57	不重要	重载函数是否有二义性？	无
58	重要	是否混淆了成员函数的重载、覆盖与隐藏？	无
59	不重要	运算符的重载是否符合制定的编程规范？	无
60	不重要	是否滥用内联函数？例如函数体内的代码比较长，函数体内出现循环。	无
61	重要	是否用内联函数取代了宏代码？	无
其它常见问题
序号	重要性	审查项	结论
62	重要	变量的数据类型有错误吗？	否
63	重要	存在不同数据类型的赋值吗？	否
64	重要	存在不同数据类型的比较吗？	否
65	重要	变量的初始化或缺省值有错误吗？	否
66	重要	变量发生上溢或下溢吗？	否
67	重要	变量的精度够吗？	是
68	重要	由于精度原因导致比较无效吗？	否
69	重要	表达式中的优先级有误吗？	否
70	重要	逻辑判断结果颠倒吗？	否
71	重要	循环终止条件不正确吗？	否
72	重要	无法正常终止（死循环）吗？	否
73	重要	错误地修改循环变量吗？	否
74	重要	存在误差累积吗？	否
75	重要	忘记进行错误处理吗？	是

五. 单元测试

1. 测试工具
   此次代码选择C++进行编写，采用VS2017自带的单元测试工具。
   
2. 测试代码

#include "pch.h"
#include "CppUnitTest.h"
#include 
#include "E:\leetcode\leetcode/源.cpp"

using namespace Microsoft::VisualStudio::CppUnitTestFramework;

namespace UnitTest1
{
	TEST_CLASS(UnitTest1)
	{
	public:
		
		TEST_METHOD(TestMethod1)
		{
			int Operator=1111;//选择运算符
			int isDecimal=1;//是否有小数
			int isBrackets=1;//是否有括号
			int Maxnum=100;//算式中最大数
			for (int i = 0; i < 10; i++)
			{
				printf("GetExercises(Operator, isDecimal, isBrackets, Maxnum)\n");
			}
			system("pause");
		}
	};
}

3. 测试结果
   

六. 总结

1. 对驾驶员的评价
   本次结对编程的驾驶员是陈郎朗同学，陈郎朗同学的编程能力较强，思路清晰，很好的实现了此次生成四则运算的要求，代码相对简短易懂，代码中出现的问题在提出后能马上改正，对代码的注释也很清晰，很好的完成了任务。
2. 总结
   在本次的结对编程作业中，我担任的角色领航员的角色，帮助陈郎朗同学完成代码的编写及就实现的图形用户界面给出设计意见，在代码完成后协助陈郎朗同学审查代码，提出改正的意见，尽量完善代码，更好的实现代码功能。此次作业我与陈郎朗同学配合的很顺畅，从最开始对选题的讨论，到界面和代码的设计，每次陈郎朗同学都会询问我的意见，看哪里还可以实现的更好，而我也在我力所能及的范围内给出了相应的建议。协助陈郎朗同学完成了他驾驶员的任务。
   因为有了第二次结对编程的经验，我很快的完成了代码的审查，并在进行单元测试时也很快的实现，在编写代码时也向陈郎朗同学进行了请教，完善了单元测试代码的编写。
   此次结对编程作业使我意识到了团队协作的重要性，一个人的力量是有限的，在进行任务的过程中会出现思路不全面的情况，进度相对来说也会慢一些，而团队合作不仅不会出现这样的问题，还会提高两人的交流沟通能力，相互学习更好地完成任务。希望在接下来的团队作业中，可以发现自己其他方面的不足并加以改正，学到更多。

七. 工作记录表

项目	预计	实际
设计时间	1h	1h
编码时间	4h	6.5h
测试时间	1h	1h
代码行数	400	280
测试代码行数	20	10
错误数量	5	10
错误修复时间	1h	2h
开发总时间	2d	2d