结对编程第一次作业

1.题目要求

(1). 首先在同学中找一个同伴,范围不限,可以在1~5班中随意组合,建议尽量不要找同组的成员,女同学尽量找男同学结对,但是不做强制要求;
(2). 从以往个人完成的项目中选择一个作品,例如:以往的数据结构课程设计或者其它具有比较完整功能的小系统,代码至少要大于100行;
(3). 将代码上传至个人GitHub或Coding.net系统中,并将代码地址交给对方;
(4). 对同伴的作品进行代码复审,并参照C/C++代码审查表和 Java代码审查表 这两篇博文的内容自行设计代码审查表并填写内容;
(5). 将对伙伴审查的结果以表格的形式写到自己的博客作业里,博客中应该附有伙伴作业的GitHub或Coding.net的代码地址;
(6). 对同伴的代码写一篇500字以上的评论,介绍同伴的优缺点。

本次我的结对伙伴是刘春慧,她的源代码是用java语言实现了一个简易计算器程序。
代码地址点这里

2.代码审查表

计算器算法审查表
重要性 激活 级别 检查项
Y 20 命名规则是否与所采用的规范保持一致?
注释  
重要 Y 10 注释是否较清晰且必要?
重要 N 10 复杂的分支流程是否已经被注释?
N 10 距离较远的}是否已经被注释?
N 10 非通用变量是否全部被注释?
N 50 函数是否已经有文档注释?(功能、输入、返回及其他可选)
重要 Y 10 特殊用法是否被注释?
声明、空白、缩进  
Y 20 每行是否只声明了一个变量?(特别是那些可能出错的类型)
重要 Y 40 变量是否已经在定义的同时初始化?
重要 Y 40 类属性是否都执行了初始化?
Y 20 代码段落是否被合适地以空行分隔?
N 20 是否合理地使用了空格使程序更清晰?
Y 20 代码行长度是否在要求之内?
Y 20 折行是否恰当?
语句/功能分布/规模  
Y 20 包含复合语句的{}是否成对出现并符合规范?
N 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 缩进层数是否不超过规定?
重要 N 100 是否已经消除了所有警告?
重要 Y 40 常数变量是否声明为final?
重要 Y 80 对象使用前是否进行了检查?
重要 N 80 局部对象变量使用后是否被复位为NULL?
重要 Y 70 对数组的访问是否是安全的?(合法的index取值为[0, MAX_SIZE-1])。
重要 Y 20 是否确认没有同名变量局部重复定义问题?
Y 20 程序中是否只使用了简单的表达式?
重要 Y 20 所有判断是否都使用了(常量==变量)的形式?
重要 N 80 是否每个if-else if-else语句都有最后一个else以确保处理了全集?
重要 N 80 是否每个switch-case语句都有最后一个default以确保处理了全集?
Y 80 for循环是否都使用了包含下限不包含上限的形式?(k=0; k
重要 Y 40 XML标记书写是否完整,字符串的拼写是否正确?
N 40 对于流操作代码的异常捕获是否有finally操作以关闭流对象?
N 20 退出代码段时是否对临时对象做了释放处理?
可靠性(函数)  
重要 N 60 入口对象是否都被进行了判断不为空?
重要 N 60 入口数据的合法范围是否都被进行了判断?(尤其是数组)
重要 N 20 是否对有异常抛出的方法都执行了try...catch保护?
重要 Y 80 是否函数的所有分支都有返回值?
重要 N 50 int的返回值是否合理?(负值为失败,非负值成功)
N 20 对于反复进行了int返回值判断是否定义了函数来处理?
Y 60 关键代码是否做了捕获异常处理?
重要 N 60 是否确保函数返回CORBA对象的任何一个属性都不能为null?
重要 N 60 是否对方法返回值对象做了null检查,该返回值定义时是否被初始化?
重要 N 60 线程处理函数循环内部是否有异常捕获处理,防止线程抛出异常而退出?
N 20 原子操作代码异常中断,使用的相关外部变量是否恢复先前状态?
重要 N 100 函数对错误的处理是恰当的?
可维护性  
重要 Y 100 实现代码中是否消除了直接常量?(用于计数起点的简单常数例外)
Y 20 是否消除了导致结构模糊的连续赋值?(如a= (b=d+c ))
N 20 是否每个return前都要有日志记录?
N 20 是否有冗余判断语句?(如:if (b) return true; else return false;)
Y 20 是否把方法中的重复代码抽象成私有函数?

3.对同伴的评论

优点:代码简洁,没有无用的代码,没有冗余判断语句,必要的地方都写了注释,段落被合适地以空行分隔,较好地运用了Tab键缩进,有较高的可读性,命名规范也易于理解,命名法使用了驼峰命名法,各种语句的格式也符合规范,对每一个变量都进行了初始化,而且考虑了当除数等于0时的情况,代码运用了大量出栈和出栈,合理的出栈入栈,对数据结构知识有很好的理解与掌握。
缺点:虽然大部分的代码都已经被注释,但某些距离较远的}没有被注释代码,部分的代码也没有合理地使用空格,使程序更清晰;实验实现的功能较简单,没有取余(%),常用函数(例sin,cos函数)等功能 ;代码没有根据功能(+,-,*,/)分成不同的类,对功能的划分不直观,不利于维护和扩展;没有使用断言,没有对不同的错误进行处理说明,也没有异常处理,不利于后续的维护。
总体来说,对于软件工程的初学者,我觉得这个代码是合格的。她避开了很多不规范的代码书写,实践和理论相结合,较充分的运用了在课上所学的知识。

猜你喜欢

转载自www.cnblogs.com/wangxinz/p/10753096.html