结对编程实验二

结对编程

导航员	王嘉城223201062231
领航员	崔贺 223201062228

实验题目

我们在刚开始上课的时候介绍过一个小学四则运算自动生成程序的例子，请实现它，要求：

1. 能够自动生成四则运算练习题
2. 可以定制题目数量
3. 用户可以选择运算符
4. 用户设置最大数（如十以内、百以内等）
5. 用户选择是否有括号、是否有小数
6. 用户选择输出方式（如输出到文件、打印机等）

最好能提供图形用户界面（根据自己能力选做，以完成上述功能为主）

实验要求

1. 能够辅助驾驶员完成全部代码工作，并且为关键函数选用合适的覆盖标准设计测试用例，并编写代码进行单元自动测试。
2. 利用结对编程作业的代码检查表（表1.2）对驾驶员的本次工作进行评价，并同时填写PSP 0.1工作记录表。
3. 能够对本次工作完成500字以上的总结。

驾驶员：系统的实现过程、算法设计、结对工作照片等

领航员：代码测试覆盖标准、测试用例、代码检查表、工作记录表等。

导航员代码地址

代码检查表

序号	重要性	审查项		结论
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	不重要	是否用隐含错误的方式写if语句？例如 （1）将布尔变量直接与TRUE、FALSE或者1、0进行比较。 （2）将浮点变量用“==”或“！=”与任何数字比较。 （3）将指针变量用“==”或“！=”与NULL比较。		否
25	不重要	如果循环体内存在逻辑判断，并且循环次数很大，是否已经将逻辑判断移到循环体的外面		无
26	重要	Case语句的结尾是否忘了加break？		无
27	重要	是否忘记写switch的default分支？		无
28	重要	使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算		无
29	不重要	是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串？		否
30	不重要	在C++ 程序中，是否用const常量取代宏常量？		否
31	重要	如果某一常量与其它常量密切相关，是否在定义中包含了这种关系？		无
32	不重要	是否误解了类中的const数据成员？因为const数据成员只在某个对象		无
33	不重要	生存期内是常量，而对于整个类而言却是可变的。		无
函数设计
34	不重要	参数的书写是否完整？不要贪图省事只写参数的类型而省略参数名字。		否
35	不重要	参数命名、顺序是否合理？		否
36	不重要	参数的个数是否太多？		否
37	不重要	是否使用类型和数目不确定的参数？		否
38	不重要	是否省略了函数返回值的类型？		否
39	不重要	函数名字与返回值类型在语义上是否冲突？		否
40	重要	是否将正常值和错误标志混在一起返回？正常值应当用输出参数获得，而错误标志用return语句返回。		否
41	重要	在函数体的“入口处”，是否用assert对参数的有效性进行检查？		无
42	重要	使用滥用了assert？ 例如混淆非法情况与错误情况，后者是必然存在的并且是一定要作出处理的。		无
43	重要	return语句是否返回指向“栈内存”的“指针”或者“引用”？		无
44	不重要	是否使用const提高函数的健壮性？const可以强制保护函数的参数、返回值，甚至函数的定义体。“Use const whenever you need”		否
内存管理
45	重要	用malloc或new申请内存之后，是否立即检查指针值是否为NULL？（防止使用指针值为NULL的内存）		无
46	不重要	否忘记为数组和动态内存赋初值？（防止将未被初始化的内存作为右值使用）		无
47	重要	数组或指针的下标是否越界？		否
48	重要	动态内存的申请与释放是否配对？（防止内存泄漏）		无
49	重要	是否有效地处理了“内存耗尽”问题？		无
50	重要	是否修改“指向常量的指针”的内容？		无
51	重要	是否出现野指针？例如（1）指针变量没有被初始化;（2）用free或delete释放了内存之后，忘记将指针设置为NULL。		无
52	重要	是否将malloc/free 和 new/delete 混淆使用？		无
53	重要	malloc语句是否正确无误？例如字节数是否正确？类型转换是否正确？		无
54	重要	在创建与释放动态对象数组时，new/delete的语句是否正确无误？		无

测试用例

代码覆盖测试结果图

工作记录表

项目	预计	实际
设计时间	10 h	20 h
编码时间	10 h	20 h
测试时间	10 h	20 h
代码行数	400	432
测试代码行数	300	350
错误数量	10	20
错误修复时间	15 h	15 h
开发总时间	45 h	75 h

代码评价

我的搭档用的是c语言编写的程序，相比较于我个人而言，我伙伴的代码比较规范，变量名称定义清晰，且把各个功能分解成了对应的子函数，这点做的是相当好的，这让人一看就知道这个变量是用来干什么的、记录什么的，也写了很多子函数，使得主函数中的程序没有那么冗杂，显得简练，这两点让人在阅读过程中感到比较轻松。在处理选择的子函数中，并没有和我一样采用了if语句，而是用了switch语句，这点也是比较好的。这几点是非常值得我学习的，因为自己的代码大多数都是在主程序里面完成的，没有子函数，而且变量名称也都是用a、b、c之类的代替，这让人看起来非常的辛苦。

我的搭档做的注释并不完全，他在主程序中的注释非常好，标注了每个函数是做什么的，让人看起来一目了然，但是美中不足的是我的伙伴在子程序中做的注释并不够详尽，虽然说并没有用到什么算法，用的一般都是for、if语句，但是有些嵌套for语句仍然需要自己慢慢看，慢慢琢磨，在这里面并没有注释是怎么实现子函数功能的，如果我的伙伴能够简要的注释一下子函数中是如何实现该功能的，那就几乎无可挑剔了；还有一点缺点就是行间代码间隔不当，这点是可以原谅的，因为我们大多数都不会注意到空格的使用，一般写代码的时候都把变量和运算或者逻辑符号都写在了一块，并没有使用空格隔开。这是我伙伴代码的两个缺点。

总结与体会

这次代码主要用了c语言，代码作者对其功能有明确的理解，自己所建立的数据结构都拥有着比较完整的功能，没有冗余或者缺少的模块。主要做法就是用将文件中数据读取到结构体链表中，进行显示、修改、增加以及减少。块化清晰，大部分函数功能明确，并且函数名称取得显而易见，让人一眼就看出来这个函数的功能，在函数结点中都对代码进行准确注释。代码的格式写的很漂亮，没有多的或者少的空格以及没有不对齐的情况。

在这次代码中，大部分问题处理得当，但是存在这一些小问题，函数中有些冗余。但代码功能写的通俗易懂。没有一些太难懂的语句，在这个代码中，有一些小的瑕疵，那就是一行中进行了多个变量的定义，在书写代码的格式中，尽量还是一行只做一件事情的较好。在每次给指针赋予内存空间时，并没有检查是否成功赋予。对文件的操作中，并没有检查文件是否成功打开。

在这次结对作业中，我同伴的代码有很多值得我学习的地方。代码的注释写的非常完善，变量名称取得通俗易懂，具有一定的意义。在他身上我也看到了一些自己的失误：在书写指针时，并没有分配了空间就立即检查他是否获得了内存空间，以及对代码万一出现事故的情况并没有太多的解决方案。