结对编程第二次作业

Posted yongliwang

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了结对编程第二次作业相关的知识,希望对你有一定的参考价值。

本次作业是要实现小学四则运算生成器,在完成作业的过程中,队友担任最重要的驾驶员工作,我担任的是领航员的工作。

一、题目要求

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

二、驾驶员工作

四则运算生成器源代码:四则运算生成器
作业布置当天,我们就开始着手做了,刚拿道题目时,我其实对于生成文件形式啊,界面啊甚至是有些功能我都完全没有头绪,但是在队友的疏通下,思路感觉清晰了许多。于是开始着手编程了。程序其实主要是队友负责的,我就是紧跟着队友的思路审查代码,并思考其中的一些易忽视的bug,在不打断队友思路的前提下,及时提醒队友。刚开始编基本功能的时候挺顺利的,但是当编到多项式时卡住了,在括号位置的处理上没有一个较好的实现。最后,在编界面时,感觉太难,起初我们都打算放弃界面的编写了,但是看到别人有生成界面的,然后我们就开始看一些视频,查阅资料,经过了一天的努力,最终把界面搭建好了。以下是程序的一部分功能。

生成界面

生成表达式

三、领航员工作

测试代码:四则运算单元测试
运算中符号是最基本的,于是我首先测试了符号的生成是否正确。选用组合覆盖。"+,-,*,/"四个符号共有15种情况,一个符号的有4中情况,两个符号的两两组合有6种情况,三个符号的有1 种情况,测试代码如下:

接下来,测试的是4个生成表达式的函数是否能被正确调用,包括整数运算,小数运算,整数多项式运算,小数多项式运算。测试代码如下:

最后,测试的是启动了那些生成表达式的函数

(有一个bug,就是多项式运算中,有可能除数会为0,这种情况没有解决掉。)
运行结果

四、代码审查表

功能模块名称 Arithmeticgenerator
审查人 王永利 审查日期 2018.4.15
代码名称 Arithmeticgenerator 代码作者 张义
文件结构
重要性 审查项 结论
头文件和定义文件的名称是否合理?
头文件和定义文件的目录结构是否合理?
版权和版本声明是否完整?
重要 头文件是否使用了 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? 例如混淆非法情况与错误情况,后者是必然存在的并且是一定要作出处理的。
重要 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。
其它常见问题
重要性 审查项 结论
重要 数据类型问题:
(1)变量的数据类型有错误吗?
(2)存在不同数据类型的赋值吗?
(3)存在不同数据类型的比较吗?
重要 变量值问题:
(1)变量的初始化或缺省值有错误吗?
(2)变量发生上溢或下溢吗?
(3)变量的精度够吗?
重要 逻辑判断问题:
(1)由于精度原因导致比较无效吗?
(2)表达式中的优先级有误吗?
(3)逻辑判断结果颠倒吗?
重要 循环问题:
(1)循环终止条件不正确吗?
(2)无法正常终止(死循环)吗?
(3)错误地修改循环变量吗?
(4)存在误差累积吗?
重要 错误处理问题:
(1)忘记进行错误处理吗?
(2)错误处理程序块一直没有机会被运行?
(3)错误处理程序块本身就有毛病吗?如报告的错误与实际错误不一致,处理方式不正确等等。
(4)错误处理程序块是“马后炮”吗?如在被它被调用之前软件已经出错。
重要 文件I/O问题:
(1)对不存在的或者错误的文件进行操作吗?
(2)文件以不正确的方式打开吗?
(3)文件结束判断不正确吗?
(4)没有正确地关闭文件吗?

五、工作总结

愉快的结对编程作业已经接近尾声,对于此次结对编程,有很多心得。刚开始看到题目之后,我和队友开始商量讨论,先确定任务分配,由于队友编程能力比我强,于是他主动担任了驾驶员的工作,负责主要的编程工作。我主要负责代码审查,减少出现bug的概率,当整个程序编完之后,我负责写测试类。有了明确的思路之后,开始编写代码,首先从最基本的两位数的加减乘除开始。从刚开始的随机数和符号的获取,一直到实现两个数的运算,包括整数与整数,小数与小数,我们的思路都很清晰,编的比较快。然后,考虑到四则运算不只是两个数的运算,我们又扩展到多项式,起初对于多项式中括号的位置处理没有思路,后来经过队友的冥思苦想和查阅资料后,终于把这个问题解决了,但是其实还没有达到太完美,因为我们只是实现了三个数的运算,并没有真正达到多项式的效果,这是我们需要改进的一个地方。在不断的努力后,程序终于编完了,接着就是到我们以前从来没有接触过的界面设计了。因为从没有用java写过界面,这块儿就是本次作业最大的难题了,一个上午的探索无果后,我内心其实是有点想要放弃了,但是当我看到队友继续埋头苦干,丝毫没有一丝懈怠的模样,我又重新打起精神,设计界面排版,上网查阅资料,向已经做过界面的同学寻求经验,在互相鼓励和帮助下,从设计排版,生成窗口,在窗口中添加按钮和文本框,如何获取文本框中的内容等,搭建界面碰到的问题被我们一个一个解决掉了。然后就是我写测试类了,程序是随机生成表达式的,因此不能测试结果的预期值与实际值的测试,于是我就对几个主要的函数进行测试。首先,我测试了是否能正确生成单个符号以及符号的组合,四个符号,每个任意选TRUE或FALSE,可以有15中结果。然后测试四个生成表达式的函数是否能正确调用,最后测试了启动了生成表达式的函数。其中队友在我写测试类的时候也是很好的帮助了我给了我很多宝贵的建议。总之,通过这次结对编程,我们都收获颇多,既认识到了自己的不足,也学习到了很多以前没有接触过的新东西,比如搭建界面。实践是学习的一个很好的途径,结对编程也是,不仅让我们能够认识到与别人之间的差距,更重要的是可以向别人学习到很多。

六、结对编程时的照片

以上是关于结对编程第二次作业的主要内容,如果未能解决你的问题,请参考以下文章

软件工程第二次作业—结对编程1

软件工程第二次作业—结对编程

软件工程第二次作业----结对编程

结对编程第二次作业

结对编程第二次作业

结对编程第二次作业