软件工程结对第二次作业
一、题目要求
1.能够自动生成四则运算练习题
2.可以定制题目数量;
3.用户可以选择运算符
4.用户设置最大数(如十以内、百以内等)
5.用户选择是否有括号、是否有小数
6.用户选择输出方式(如输出到文件、打印机等)
7.最好能提供图形用户界面(根据自己能力选做,以完成上述功能为主)
二、角色分配
这次作业,我和陈静男同学都当了一次领航员和驾驶员,两个人都写了一份代码,交给对方互审
同伴coding地址:
本人coding地址:https://git.dev.tencent.com/dtid_c22519733a7f7749/ruanjian.git
同伴的博客地址:https://www.cnblogs.com/cheng0000jing/p/10808268.html
二、作为驾驶员的部分
初始界面
1.当选择有括号,有小数,打印50组,最大值为100,加减乘除都有,输出方式为页面输出的情况时
2.当选择无括号,无小数,打印50组,最大值为100,有减乘除,输出方式为文件输出的情况时</h3
3.当选择有括号,无小数,打印50组,最大值为100,有加乘除,输出方式为页面输出的情况时</h3
4.当选择无括号,有小数,打印50组,最大值为100,有减乘,输出方式为文件输出的情况时</h3
三、错误处理(当输入的信息有误时跳转错误处理页面)
四、代码
五、作为领航员的部分
功能模块名称 | 自动生成四则运算 | ||
审查人 | 吕宏林 | 审查日期 | 2019.5.5 |
代码名称 | 自动生成四则运算 | 代码作者 | 陈静男 |
重要性 | 激活 | 级别 | 检查项 |
总计 | |||
命名 | |||
重要 | Y | 20 | 命名规则是否与所采用的规范保持一致? |
Y | 20 | 是否遵循了最小长度最多信息原则? | |
重要 | Y | 50 | has/can/is前缀的函数是否返回布尔型? |
注释 | |||
重要 | N | 10 | 注释是否较清晰且必要? |
重要 | Y | 10 | 复杂的分支流程是否已经被注释? |
N | 10 | 距离较远的}是否已经被注释? | |
Y | 10 | 非通用变量是否全部被注释? | |
重要 | Y | 50 | 函数是否已经有文档注释?(功能、输入、返回及其他可选) |
N | 10 | 特殊用法是否被注释? | |
声明、空白、缩进 | |||
N | 20 | 每行是否只声明了一个变量?(特别是那些可能出错的类型) | |
重要 | Y | 40 | 变量是否已经在定义的同时初始化? |
重要 | Y | 40 | 类属性是否都执行了初始化? |
Y | 20 | 代码段落是否被合适地以空行分隔? | |
Y | 20 | 是否合理地使用了空格使程序更清晰? | |
Y | 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 | 单个函数是否执行了单个功能并与其命名相符? |
Y | 20 | 操作符++和— —操作符的应用是否复合规范? | |
规模 | |||
重要 | Y | 20 | 单个函数不超过规定行数? |
重要 | Y | 100 | 缩进层数是否不超过规定? |
重要 | Y | 100 | 是否已经消除了所有警告? |
重要 | Y | 40 | 常数变量是否声明为final? |
重要 | Y | 80 | 对象使用前是否进行了检查? |
重要 | Y | 80 | 局部对象变量使用后是否被复位为NULL? |
重要 | Y | 70 | 对数组的访问是否是安全的?(合法的index取值为[0, MAX_SIZE-1])。 |
重要 | Y | 20 | 是否确认没有同名变量局部重复定义问题? |
Y | 20 | 程序中是否只使用了简单的表达式? | |
重要 | Y | 20 | 是否已经用()使操作符优先级明确化? |
重要 | Y | 20 | 所有判断是否都使用了(常量==变量)的形式? |
Y | 80 | 是否消除了流程悬挂? | |
重要 | Y | 80 | 是否每个if-else if-else语句都有最后一个else以确保处理了全集? |
重要 | Y | 80 | 是否每个switch-case语句都有最后一个default以确保处理了全集? |
N | 80 | for循环是否都使用了包含下限不包含上限的形式?(k=0; k<MAX) | |
重要 | 40 | XML标记书写是否完整,字符串的拼写是否正确? | |
N | 40 | 对于流操作代码的异常捕获是否有finally操作以关闭流对象? | |
N | 20 | 退出代码段时是否对临时对象做了释放处理? | |
重要 | Y | 40 | 对浮点数值的相等判断是否是恰当的?(严禁使用==直接判断) |
可靠性(函数) | |||
重要 | Y | 60 | 入口对象是否都被进行了判断不为空? |
重要 | Y | 60 | 入口数据的合法范围是否都被进行了判断?(尤其是数组) |
重要 | Y | 20 | 是否对有异常抛出的方法都执行了try...catch保护? |
重要 | Y | 80 | 是否函数的所有分支都有返回值? |
重要 | Y | 50 | int的返回值是否合理?(负值为失败,非负值成功) |
Y | 20 | 对于反复进行了int返回值判断是否定义了函数来处理? | |
Y | 60 | 关键代码是否做了捕获异常处理? | |
重要 | Y | 60 | 是否确保函数返回CORBA对象的任何一个属性都不能为null? |
重要 | Y | 60 | 是否对方法返回值对象做了null检查,该返回值定义时是否被初始化? |
重要 | Y | 60 | 是否对同步对象的遍历访问做了代码同步? |
重要 | Y | 80 | 是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作? |
重要 | 60 | 线程处理函数循环内部是否有异常捕获处理,防止线程抛出异常而退出? | |
20 | 原子操作代码异常中断,使用的相关外部变量是否恢复先前状态? | ||
重要 | 100 | 函数对错误的处理是恰当的? | |
可维护性 | |||
重要 | Y | 100 | 实现代码中是否消除了直接常量?(用于计数起点的简单常数例外) |
Y | 20 | 是否消除了导致结构模糊的连续赋值?(如a= (b=d+c )) | |
Y | 20 | 是否每个return前都要有日志记录? | |
N | 20 | 是否有冗余判断语句?(如:if (b) return true; else return false;) | |
Y | 20 | 是否把方法中的重复代码抽象成私有函数? |
总结
作为驾驶员的体会:
经过这次结对合作,我发现,代码有很多不足,因为没有全身心的去完成这个作业,导致里面有一些bug没有被注意到,比如除数不能为0,
括号只随机生成了一个,没有随机的生成多个括号,并且没有编写格式校验器,只是很随便的用了一个异常处理的注解,这个导致了,出现没有考虑到的异常的时候会出现错误页面,导致与用户的交互性很差,在是否生成浮点数的过程中,我只是简单的再整数的后面,加了一个点和一个随机生成的数,没有考虑到,整数和浮点数混合的情况,还有就是没有写入得数校验的代码,总体来说,这次作业完成的很不好,投入的时间太少了,到会代码的漏洞和bug很多。
作为领航员的体会:
经过阅读了陈静男同学的代码之后,发现自己有很多不足,他的图形化界面做的很好,和用户交互的感觉很舒适,编写的代码也严格遵守了命名规范,他考虑的很周到,对于括号和除数不为0,和错误处理的情况,都有了妥善的处理,我的几个bug和缺陷,也是在陈静男同学的指引下,发现的的,他的代码没有bug,代码量比较多,每一个代码都负责一部分功能,让阅读者能更清晰的读懂他的代码,作为领航员,对陈静男同学没有多少帮助,因为自己还没有学过swing,总体来说,这次领航员的体验,也让我知道了,领航员的重要性,一个工作中,如果没有一个人给你指引方向,那将会很累,在以后的工作中,同样需要这样的一个角色,调度每一个程序员,让他编写它最擅长的部分,最后将他们的代码整合到一起,总之,领航员的工作很多,我们学到的只是冰山一角,希望在以后的学习中,能更深入的体会,结对作业或者团队作业这种集体编程的含义。