软件工程结对编程第二次作业
四则运算要求
- 能够自动生成四则运算练习题
- 可以定制题目数量
- 用户可以选择运算符
- 用户设置最大数(如十以内、百以内等)
- 用户选择是否有括号、是否有小数
- 用户选择输出方式(如输出到文件、打印机等)
- 最好能提供图形用户界面(根据自己能力选做,以完成上述功能为主)
本次任务中扮演的角色及任务要求
在本次结对作业中我是一名领航员,负责辅助驾驶员完成全部代码工作,并且为关键函数选用合适的覆盖标准设计测试用例,并编写代码进行单元自动测试。根据代码检查表对驾驶员的本次工作进行评价,以及对于本次工作完成500字以上的总结。
代码测试
代码审查表
重要性 | 级别 | 检查项 | 结果 |
---|---|---|---|
总计 | |||
命名 | |||
重要 | 20 | 命名规则是否与所采用的规范保持一致? | Y |
20 | 是否遵循了最小长度最多信息原则? | Y | |
重要 | 50 | has/can/is前缀的函数是否返回布尔型? | N |
注释 | |||
重要 | 10 | 注释是否较清晰且必要? | Y |
重要 | 10 | 复杂的分支流程是否已经被注释? | N |
10 | 距离较远的}是否已经被注释? | N | |
10 | 非通用变量是否全部被注释? | N | |
重要 | 50 | 函数是否已经有文档注释?(功能、输入、返回及其他可选) | N |
10 | 特殊用法是否被注释? | N | |
声明、空白、缩进 | |||
20 | 每行是否只声明了一个变量?(特别是那些可能出错的类型) | Y | |
重要 | 40 | 变量是否已经在定义的同时初始化? | N |
重要 | 40 | 类属性是否都执行了初始化? | Y |
20 | 代码段落是否被合适地以空行分隔? | N | |
20 | 是否合理地使用了空格使程序更清晰? | N | |
20 | 代码行长度是否在要求之内? | Y | |
20 | 折行是否恰当? | Y | |
语句/功能分布/规模 | |||
20 | 包含复合语句的{}是否成对出现并符合规范? | Y | |
20 | 是否给单个的循环、条件语句也加了{}? | Y | |
20 | if/if-else/if-else if-else/do-while/switch-case语句的格式是否符合规范? | Y | |
40 | 单个变量是否只做单个用途? | Y | |
重要 | 20 | 单行是否只有单个功能?(不要使用;进行多行合并) | Y |
重要 | 40 | 单个函数是否执行了单个功能并与其命名相符? | N |
20 | 操作符++和— —操作符的应用是否复合规范? | Y | |
规模 | |||
重要 | 20 | 单个函数不超过规定行数? | N |
重要 | 100 | 缩进层数是否不超过规定? | Y |
重要 | 100 | 是否已经消除了所有警告? | N |
重要 | 40 | 常数变量是否声明为final? | N |
重要 | 80 | 对象使用前是否进行了检查? | N |
重要 | 80 | 局部对象变量使用后是否被复位为NULL? | N |
重要 | 70 | 对数组的访问是否是安全的?(合法的index取值为[0, MAX_SIZE-1])。 | Y |
重要 | 20 | 是否确认没有同名变量局部重复定义问题? | Y |
20 | 程序中是否只使用了简单的表达式? | Y | |
重要 | 20 | 是否已经用()使操作符优先级明确化? | N |
重要 | 20 | 所有判断是否都使用了(常量==变量)的形式? | N |
80 | 是否消除了流程悬挂? | Y | |
重要 | 80 | 是否每个if-else if-else语句都有最后一个else以确保处理了全集? | N |
重要 | 80 | 是否每个switch-case语句都有最后一个default以确保处理了全集? | Y |
80 | for循环是否都使用了包含下限不包含上限的形式?(k=0; k<MAX) | N | |
重要 | 40 | XML标记书写是否完整,字符串的拼写是否正确? | Y |
40 | 对于流操作代码的异常捕获是否有finally操作以关闭流对象? | N | |
20 | 退出代码段时是否对临时对象做了释放处理? | N | |
重要 | 40 | 对浮点数值的相等判断是否是恰当的?(严禁使用==直接判断) | N |
可靠性(函数) | |||
重要 | 60 | 入口对象是否都被进行了判断不为空? | N |
重要 | 60 | 入口数据的合法范围是否都被进行了判断?(尤其是数组) | N |
重要 | 20 | 是否对有异常抛出的方法都执行了try...catch保护? | Y |
重要 | 80 | 是否函数的所有分支都有返回值? | N |
重要 | 50 | int的返回值是否合理?(负值为失败,非负值成功) | Y |
20 | 对于反复进行了int返回值判断是否定义了函数来处理? | N | |
60 | 关键代码是否做了捕获异常处理? | Y | |
重要 | 60 | 是否确保函数返回CORBA对象的任何一个属性都不能为null? | Y |
重要 | 60 | 是否对方法返回值对象做了null检查,该返回值定义时是否被初始化? | N |
重要 | 60 | 是否对同步对象的遍历访问做了代码同步? | N |
重要 | 80 | 是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作? | N |
重要 | 60 | 线程处理函数循环内部是否有异常捕获处理,防止线程抛出异常而退出? | Y |
20 | 原子操作代码异常中断,使用的相关外部变量是否恢复先前状态? | Y | |
重要 | 100 | 函数对错误的处理是恰当的? | Y |
可维护性 | |||
重要 | 100 | 实现代码中是否消除了直接常量?(用于计数起点的简单常数例外) | Y |
20 | 是否消除了导致结构模糊的连续赋值?(如a= (b=d+c )) | Y | |
20 | 是否每个return前都要有日志记录? | N | |
20 | 是否有冗余判断语句?(如:if (b) return true; else return false;) | N | |
20 | 是否把方法中的重复代码抽象成私有函数? | Y |
对驾驶员的评价
话不多说,先奉上我们一起工作的照片。
在本次结对编程任务过程中,驾驶员运用自己所学知识顺利的编写出了老师布置的题目代码。驾驶员的代码思路清晰、整洁规范、命名易懂,基本符合代码规范。但是在代码复审环节中也有不足的地方,注释还可以在详尽些,把长一点的函数可以拆开,写的短一些,这样还可以减少代码冗余。总体而言,驾驶员的表现也是十分优秀,只是有些许的方面还可以提高。
总结
在本次结对作业中,我担任的是领航员角色主要负责后期的测试工作,聪颖机智帅气的付港华同学担任的是驾驶员角色,主要负责代码编辑工作。然而在代码的编辑过程中我并没有起到什么有建设性意义的作用,仅仅是做了一个酱油而已,这点让我感觉到有些惭愧。经过多天的不懈努力,渐渐地,我们的代码完成了并按照代码规范改进了,此时我们终于完成了本次结对编程的任务。在任务行进过程中,我们学会随机函数的调用并用其生成算式,也改进了编代码的风格,使代码尽可能的规范,试着在代码中加入了注释,尽管还有不足的地方,但是经过此次历练,感觉自己提高了,进步了。经过这次结对作业加深了队友之间的了解, 同时也从队友的身上学会了很多东西,也更加深刻领会了合作的重要性,也使我们认识到一个程序的编写乃至于一个项目的开发都要严格按照一定的规范来执行,只有这样才能为后续的工作做好准备,方便以后的工作,仿佛突然就意识到了软件工程课程的意义之所在。编代码不仅仅是编代码,更是一种艺术,一种对于生活的态度。我也意识到了自己对于知识的匮乏太严重了,应该加快学习的步伐,为自己的大脑快速补充些营养了。