软件工程(2019)结对编程第二次作业
1.题目要求
- 能够自动生成四则运算练习题
- 可以定制题目数量
- 用户可以选择运算符
- 用户设置最大数(如十以内、百以内等)
- 用户选择是否有括号、是否有小数
- 用户选择输出方式(如输出到文件、打印机等)
- 最好能提供图形用户界面(根据自己能力选做,以完成上述功能为主)
2.成员分工
- 驾驶员 蒋有志
- 领航员 马宝贺
3.代码地址
代码地址:代码
4.代码审查表
本次实验在算法实现上使用c++语言,在界面生成时替换为JavaScript语言,因审查表和单元测试的关系,只对c++语言部分进行审查与单元测试。
功能模块名称 | 四则运算 | ||
审查人 | 马宝贺 | 审查日期 | 2019.5.5 |
代码名称 | main.cpp | 代码作者 | 蒋有志 |
文件结构 | |||
重要性 | 审查项 | 结论 | |
头文件和定义文件的名称是否合理? | 是 | ||
头文件和定义文件的目录结构是否合理? | 是 | ||
版权和版本声明是否完整? | 不适用 | ||
重要 | 头文件是否使用了 ifndef/define/endif 预处理块? | 是 | |
头文件中是否只存放“声明”而不存放“定义” | 否 | ||
程序的版式 | |||
重要性 | 审查项 | 结论 | |
空行是否得体? | 是 | ||
代码行内的空格是否得体? | 得体 | ||
长行拆分是否得体? | 是 | ||
“{” 和 “}” 是否各占一行并且对齐于同一列? | 是 | ||
重要 | 一行代码是否只做一件事?如只定义一个变量,只写一条语句。 | 否 | |
重要 | If、for、while、do等语句自占一行,不论执行语句多少都要加 “{}”。 | 是 | |
重要 | 在定义变量(或参数)时,是否将修饰符 * 和 & 紧靠变量名?注释是否清晰并且必要? | 注释清晰 | |
重要 | 注释是否有错误或者可能导致误解? | 否 | |
命名规则 | |||
重要性 | 审查项 | 结论 | |
重要 | 命名规则是否与所采用的操作系统或开发工具的风格保持一致? | 是 | |
标识符是否直观且可以拼读? | 是 | ||
标识符的长度应当符合“min-length && max-information”原则? | 是 | ||
重要 | 程序中是否出现相同的局部变量和全部变量? | 是 | |
类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则? | 是 | ||
静态变量、全局变量、类的成员变量是否加前缀? | 否 | ||
表达式与基本语句 | |||
重要性 | 审查项 | 结论 | |
重要 | 如果代码行中的运算符比较多,是否已经用括号清楚地确定表达式的操作顺序? | 是 | |
是否编写太复杂或者多用途的复合表达式? | 否 | ||
重要 | 是否将复合表达式与“真正的数学表达式”混淆? | 否 | |
重要 | 是否用隐含错误的方式写if语句? 例如 | ||
(1)将布尔变量直接与TRUE、FALSE或者1、0进行比较。 | 否 | ||
(2)将浮点变量用“==”或“!=”与任何数字比较。 | 否 | ||
(3)将指针变量用“==”或“!=”与NULL比较。 | 否 | ||
如果循环体内存在逻辑判断,并且循环次数很大,是否已经将逻辑判 | 不适用 | ||
断移到循环体的外面? | |||
重要 | Case语句的结尾是否忘了加break? | 不适用 | |
重要 | 是否忘记写switch的default分支? | 不适用 | |
重要 | 使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 | 不适用 | |
常量 | |||
重要性 | 审查项 | 结论 | |
是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串? | 是 | ||
在C++ 程序中,是否用const常量取代宏常量? | 否 | ||
重要 | 如果某一常量与其它常量密切相关,是否在定义中包含了这种关系? | 是 | |
函数设计 | |||
重要性 | 审查项 | 结论 | |
参数的书写是否完整?不要贪图省事只写参数的类型而省略参数名字。 | 是 | ||
参数命名、顺序是否合理? | 是 | ||
参数的个数是否太多? | 否 | ||
是否使用类型和数目不确定的参数? | 否 | ||
是否省略了函数返回值的类型? | 否 | ||
函数名字与返回值类型在语义上是否冲突? | 否 | ||
重要 | 是否将正常值和错误标志混在一起返回?正常值应当用输出参数获得,而错误标志用return语句返回。 | 否 | |
重要 | 在函数体的“入口处”,是否用assert对参数的有效性进行检查? | 是 | |
重要 | 使用滥用了assert? 例如混淆非法情况与错误情况,后者是必然存在的并且是一定要作出处理的。 | 否 | |
重要 | return语句是否返回指向“栈内存”的“指针”或者“引用”? | 否 | |
是否使用const提高函数的健壮性?const可以强制保护函数的参数、返回值,甚至函数的定义体。“Use const whenever you need” | 否 | ||
内存管理 | |||
重要性 | 审查项 | 结论 | |
重要 | 是否忘记为数组和动态内存赋初值?(防止将未被初始化的内存作为右值使用) | 否 | |
重要 | 是否将malloc/free 和 new/delete 混淆使用? | 否 | |
重要 | malloc语句是否正确无误?例如字节数是否正确?类型转换是否正 确? | 不适用 | |
重要 | 在创建与释放动态对象数组时,new/delete的语句是否正确无误? | 不适用 | |
其它常见问题 | |||
重要性 | 审查项 | 结论 | |
重要 | 数据类型问题: | ||
(1)变量的数据类型有错误吗? | 否 | ||
(2)存在不同数据类型的赋值吗? | 否 | ||
(3)存在不同数据类型的比较吗? | 否 | ||
重要 | 变量值问题: | ||
(1)变量的初始化或缺省值有错误吗? | 否 | ||
(2)变量发生上溢或下溢吗? | 否 | ||
(3)变量的精度够吗? | 够 | ||
重要 | 逻辑判断问题: | ||
(1)由于精度原因导致比较无效吗? | 否 | ||
(2)表达式中的优先级有误吗? | 否 | ||
(3)逻辑判断结果颠倒吗? | 否 | ||
重要 | 循环问题: | ||
(1)循环终止条件不正确吗? | 否 | ||
(2)无法正常终止(死循环)吗? | 否 | ||
(3)错误地修改循环变量吗? | 否 | ||
(4)存在误差累积吗? | 否 | ||
重要 | 错误处理问题: | ||
(1)忘记进行错误处理吗? | 否 | ||
(2)错误处理程序块一直没有机会被运行? | 否 | ||
(3)错误处理程序块本身就有毛病吗?如报告的错误与实际错误不一致,处理方式不正确等等。 | 否 | ||
(4)错误处理程序块是“马后炮”吗?如在被它被调用之前软件已经出错。 | 否 | ||
重要 | 文件I/O问题 | ||
(1)对不存在的或者错误的文件进行操作吗? | 否 | ||
(2)文件以不正确的方式打开吗? | 否 | ||
(3)文件结束判断不正确吗? | 否 | ||
(4)没有正确地关闭文件吗? | 否 |
5.单元测试
本次实验,因表达式生成为随机数生成,所以不利于单元测试,只附上程序的运行图。
从图中可以看出,此程序满足了任务的基本要求,并增加了在线答题,判断对错,计时等功能,在运行结果中也无任何错误。
6.对驾驶员的工作评价
本次四则运算生成程序的设计,从初期的基本功能分析,基本功能实现,到后来进行图形界面的设计,最后又附加了计时功能和在线答题功能,蒋有志同学发挥了很大的作用。这次作业,看起来好像有一些简单,但真正的做起来却比想象中麻烦很多,代码量也比想象中的大,尽管如此困难,蒋有志同学仍然能举重若轻的完成这次任务。在代码分析时,驾驶员进行了详细的代码分析,将题目中的要求,分为几个功能函数进行实现。在编写代码的过程中,驾驶员也遇到了一些问题,如小数的产生,括号的产生,以及我们增加的计算功能的实现,我们对于这些问题进行了讨论,最终解决了这些问题。在我们合作完成这次作业的同时,我也在观察蒋有志同学的代码书写风格并学习其面对问题时的心态,在他身上有很多值得我学习的地方。总的来说,蒋有志驾驶员非常出色,完成工作细致,有责任有担当,而且在出现问题时我们很容易沟通,为人善良,是一个很好的伙伴。
7.总结
这一次结对编程作业,我的身份是领航员,因为之前都是个人编程,所以没有做领航员的经验,我在紧张的同时,也希望能做好此次作业领航员的角色。在课堂时,老师就讲过领航员这一角色,听起来比较容易,但在我真正的了解领航员之后,我对这一角色又有了新的认识。领航员不只是简单的帮助驾驶员完成代码,在驾驶员完成一个功能函数时,领航员要立即用单元测试来测试这个函数的正确性,防止在之后用到这个函数时,出现一些问题。虽然在理论的学习中,明白了领航员应该干的事,但在真正的真刀真枪的程序设计时,我有时也会感到帮不上忙,有一种有劲使不出的感觉,可能从个人编程到结对辅助编程,角色的切换确实需要一定的时间来完成。本次结对作业,我更理解了结对合作的重要性,驾驶员领航员,每一个角色都有其重要意义,良好的沟通必不可少,而在结对任务中角色随时切换也很重要,希望在之后的作业,我和我的小伙伴能发挥的更好。