博客信息 | 沈阳航空航天大学计算机学院2020软件工程作业 |
---|---|
作业要求 | https://edu.cnblogs.com/campus/sau/Computer1701-1705/homework/10685 |
课程目标 | 熟悉一个“高质量”软件的开发过程 |
作业目标 | 结对编程练习 |
一、题目要求;
我们在刚开始上课的时候介绍过一个小学四则运算自动生成程序的例子,请实现它,要求:
能够自动生成四则运算练习题
可以定制题目数量
用户可以选择运算符
用户设置最大数(如十以内、百以内等)
用户选择是否有括号、是否有小数
用户选择输出方式(如输出到文件、打印机等)
最好能提供图形用户界面(根据自己能力选做,以完成上述功能为主)
二、代码审查
审查代码作者:赵子伟
审查人:韩宏泽
审查日期:2020-04-27
代码名称:小学四则运算自动生成程序
代码链接
序号 | 重要性 | 审查项 | 结论 |
---|---|---|---|
1 | 不重要 | 头文件和定义文件的名称是否合理? | 是 |
2 | 重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | 无 |
3 | 不重要 | 头文件中是否只存放“声明”而不存放“定义” | 是 |
4 | 不重要 | 代码行内的空格是否得体? | 是 |
5 | 不重要 | “{” 和 “}” 是否各占一行并且对齐于同一列? | 是 |
6 | 重要 | 一行代码是否只做一件事?如只定义一个变量,只写一条语句。 | 是 |
7 | 重要 | If、for、while、do等语句自占一行,不论执行语句多少都要加 “{}”。 | 是 |
8 | 重要 | 在定义变量(或参数)时,是否将修饰符 * 和 & 紧靠变量名?注释是否清晰并且必要? | 是 |
9 | 重要 | 注释是否有错误或者可能导致误解? | 否 |
10 | 重要 | 类结构的public, protected, private顺序是否在所有的程序中保持一致? | 无 |
11 | 重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致? | 是 |
12 | 不重要 | 标识符是否直观且可以拼读? | 是 |
13 | 重要 | 程序中是否出现相同的局部变量和全部变量? | 是 |
14 | 不重要 | 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则? | 无 |
15 | 重要 | 如果代码行中的运算符比较多,是否已经用括号清楚地确定表达式的操作顺序? | 是 |
16 | 不重要 | 是否编写太复杂或者多用途的复合表达式? | 否 |
17 | 重要 | 是否将复合表达式与“真正的数学表达式”混淆? | 否 |
18 | 重要 | 是否用隐含错误的方式写if语句? | 否 |
19 | 不重要 | 如果循环体内存在逻辑判断,并且循环次数很大,是否已经将逻辑判 | 是 |
20 | 重要 | Case语句的结尾是否忘了加break? | 无 |
21 | 重要 | 是否忘记写switch的default分支? | 无 |
22 | 重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 无 |
23 | 不重要 | 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串? | 是 |
24 | 不重要 | 在C++ 程序中,是否用const常量取代宏常量? | 无 |
25 | 重要 | 如果某一常量与其它常量密切相关,是否在定义中包含了这种关系? | 是 |
26 | 不重要 | 是否误解了类中的const数据成员?因为const数据成员只在某个对象 | 无 |
27 | 不重要 | 生存期内是常量,而对于整个类而言却是可变的。 | 是 |
28 | 不重要 | 参数的书写是否完整?不要贪图省事只写参数的类型而省略参数名字。 | 是 |
29 | 不重要 | 参数命名、顺序是否合理? | 是 |
30 | 不重要 | 函数名字与返回值类型在语义上是否冲突? | 否 |
31 | 重要 | 是否将正常值和错误标志混在一起返回?正常值应当用输出参数获得,而错误标志用return语句返回。 | 否 |
32 | 重要 | 在函数体的“入口处”,是否用assert对参数的有效性进行检查? | 无 |
33 | 重要 | 使用滥用了assert? 例如混淆非法情况与错误情况,后者是必然存在的并且是一定要作出处理的。 | 无 |
34 | 重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”? | 否 |
35 | 不重要 | 是否使用const提高函数的健壮性?const可以强制保护函数的参数、返回值,甚至函数的定义体。“Use const whenever you need” | 无 |
36 | 重要 | 用malloc或new申请内存之后,是否立即检查指针值是否为NULL?(防止使用指针值为NULL的内存) | 无 |
37 | 重要 | 是否忘记为数组和动态内存赋初值?(防止将未被初始化的内存作为右值使用) | 否 |
38 | 重要 | 数组或指针的下标是否越界? | 否 |
39 | 重要 | 动态内存的申请与释放是否配对?(防止内存泄漏) | 无 |
40 | 重要 | 是否有效地处理了“内存耗尽”问题? | 无 |
41 | 重要 | 是否修改“指向常量的指针”的内容? | 无 |
42 | 重要 | 是否出现野指针?例如(1)指针变量没有被初始化;(2)用free或delete释放了内存之后,忘记将指针设置为NULL。 | 无 |
43 | 重要 | 是否将malloc/free 和 new/delete 混淆使用? | 无 |
44 | 重要 | malloc语句是否正确无误?例如字节数是否正确?类型转换是否正 确? | 无 |
45 | 重要 | 在创建与释放动态对象数组时,new/delete的语句是否正确无误? | 无 |
46 | 不重要 | 重载函数是否有二义性? | 无 |
47 | 重要 | 是否混淆了成员函数的重载、覆盖与隐藏? | 无 |
48 | 不重要 | 运算符的重载是否符合制定的编程规范? | 是 |
49 | 不重要 | 是否滥用内联函数?例如函数体内的代码比较长,函数体内出现循环。 | 无 |
50 | 重要 | 是否用内联函数取代了宏代码? | 无 |
51 | 重要 | 是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数(1)缺省的无参数构造函数;(2)缺省的拷贝构造函数;(3)缺省的析构函数;4)缺省的赋值函数。 | 无 |
52 | 重要 | 构造函数中是否遗漏了某些初始化工作? | 无 |
53 | 重要 | 是否正确地使用构造函数的初始化表? | 无 |
54 | 重要 | 析构函数中是否遗漏了某些清除工作? | 无 |
55 | 不重要 | 是否错写、错用了拷贝构造函数和赋值函数? | 无 |
56 | 重要 | 赋值函数一般分四个步骤:(1)检查自赋值;(2)释放原有内存资源;(3)分配新的内存资源,并复制内容;(4)返回 *this。是否遗漏了重要步骤? | 无 |
57 | 重要 | 是否正确地编写了派生类的构造函数、析构函数、赋值函数? | 无 |
58 | 重要 | 是否违背了继承和组合的规则? | 无 |
59 | 重要 | 若在逻辑上B是A的“一种”,并且A的所有功能和属性对B而言都有意义,则允许B继承A的功能和属性。 | 无 |
60 | 重要 | 若在逻辑上A是B的“一部分”(a part of),则不允许B从A派生,而是要用A和其它东西组合出B。 | 无 |
61 | 重要 | 变量的数据类型有错误吗? | 否 |
62 | 重要 | 存在不同数据类型的赋值吗? | 否 |
63 | 重要 | 存在不同数据类型的比较吗? | 否 |
64 | 重要 | 变量的初始化或缺省值有错误吗? | 否 |
65 | 重要 | 变量发生上溢或下溢吗? | 否 |
66 | 重要 | 变量的精度够吗? | 是 |
67 | 重要 | 由于精度原因导致比较无效吗? | 否 |
68 | 重要 | 表达式中的优先级有误吗? | 无 |
69 | 重要 | 逻辑判断结果颠倒吗? | 否 |
70 | 重要 | 循环终止条件不正确吗? | 否 |
71 | 重要 | 错误地修改循环变量吗? | 否 |
72 | 重要 | 存在误差累积吗? | 否 |
73 | 重要 | 忘记进行错误处理吗? | 无 |
74 | 重要 | 错误处理程序块一直没有机会被运行? | 否 |
75 | 重要 | 错误处理程序块本身就有毛病吗?如报告的错误与实际错误不一致,处理方式不正确等等。 | 否 |
76 | 重要 | 错误处理程序块是“马后炮”吗?如在被它被调用之前软件已经出错。 | 否 |
77 | 重要 | 对不存在的或者错误的文件进行操作吗? | 无 |
78 | 重要 | 文件以不正确的方式打开吗? | 无 |
79 | 重要 | 文件结束判断不正确吗? | 无 |
80 | 重要 | 没有正确地关闭文件吗? | 无 |
三、单元测试
首先我对伙伴的代码进行分析,算数长度是可以变换的,可以是3到7个算数。我感觉这是我的驾驶员代码的出色之处。然后对我的驾驶员代码进行单元测试,我选的是语句覆盖条件。只要我输入正确的案例他就能够输出结果。
单元测试图如下图所示
通过这两组测试用例就能够完成语句覆盖测试。
四、工作记录表
项目 | 预计 | 实际 |
---|---|---|
设计时间 | 1h | 1h |
编码时间 | 3h | 3h |
测试时间 | 2h | 2h |
代码行数 | 300 | 158 |
测试代码行数 | 100 | 29 |
错误数量 | 10 | 4 |
错误修复时间 | 3h | 2h |
开发总时间 | 7d | 5d |
五、工作总结
通过这次结对编程,我复习了前次作业的单元测试模块,也对相互合作编程更加熟悉了。在本次结对作业中我担任了领航员的角色,首先要与驾驶员进行沟通,共同确认选题,即旅游的路线;其次在研究功能你功能的实现,即出行前决定要带的行李。然后在代码完成以后,我在对代码进行检查。对代码中不合理或者不完美的地方进行改进,在这个过程中我好比是用户,能真正发现这个代码的实用性。指出不足的同时自己也能有所警惕,在以后编写代码的过程中我也能够站在客户的角度去想问题这个代码适不适用,功能全不全等要求。
其次在今年这种特殊的授课方式下,两个人不能面对面的讨论,光凭在网上讨论也是一种挑战,但是我与我的队友之前通过QQ新出的屏幕共享功能共同决策我们的题目,我感觉这对我来说是一种全新的团队学习模式,不亚于面对面研究,甚至感觉在线上的讨论还有学习效率比现实的更高一些。总之吧还是挺感谢这门课程的,也收获到了不少知识。不仅是学术方面的,也有在未来结对编程方面的。结对编程是两个人相互合作,过一阶段就是团队编程,扩大了团队规模。通过这次结对编程项目,我感觉也有信心顺利的完成下次的团队项目,并且会取得一个非常不错的成绩。通过这次结对编程,我复习了前次作业的单元测试模块,也对相互合作编程更加熟悉了。在本次结对作业中我担任了领航员的角色,首先要与驾驶员进行沟通,共同确认选题,即旅游的路线;其次在研究功能你功能的实现,即出行前决定要带的行李。然后在代码完成以后,我在对代码进行检查。对代码中不合理或者不完美的地方进行改进,在这个过程中我好比是用户,能真正发现这个代码的实用性。指出不足的同时自己也能有所警惕,在以后编写代码的过程中我也能够站在客户的角度去想问题这个代码适不适用,功能全不全等要求。
其次在今年这种特殊的授课方式下,两个人不能面对面的讨论,光凭在网上讨论也是一种挑战,但是我与我的队友之前通过QQ新出的屏幕共享功能共同决策我们的题目,我感觉这对我来说是一种全新的团队学习模式,不亚于面对面研究,甚至感觉在线上的讨论还有学习效率比现实的更高一些。总之吧还是挺感谢这门课程的,也收获到了不少知识。不仅是学术方面的,也有在未来结对编程方面的。结对编程是两个人相互合作,过一阶段就是团队编程,扩大了团队规模。通过这次结对编程项目,我感觉也有信心顺利的完成下次的团队项目,并且会取得一个非常不错的成绩。