开放原子开发者工作坊

软件工程第四次作业

1. 题目要求

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

2. 结对同学

本次结对作业，我结对的同学是吕宏林,以下是他的代码地址和博客地址

代码托管平台地址
博客地址

他的项目实现的斗地主发牌功能。指定的斗地主成员为张三，李四，王五。需要在程序中指定地主的名字，指定的地主比其他农民多获得3张牌。

3.代码评价

吕宏林同学的code从总体来看是不错的。程序简单明确，结果运行也符合需求，没有Bug。

他的代码有很多优点：

• 程序功能设计完整，无论是在用户的输入还是程序函数的相互调用设计的都很完整。没有重复的变量，也没有无用的代码端。
• 程序代码的可读性大体完善。程序代码量很少，没有复杂的表达式，也没有复杂的程序调用，没有复杂的设计模式。所以在程序的可读性方面做的很好。
• 一个老程序员的可以从他的命名方面看出他的手艺，而吕宏林的命名还是很规范的。从这点看，他是一个优秀的程序员。
• 在数据结构的选取方面十分优秀，通过几个java内置的对象就解决了问题。

他的代码还有以下问题：

• 流的操作没有关闭，在程序结束的时候没有清理资源输入流的资源。
• 程序代码太疏忽，有的函数的括号的缩进有些问题。导致代码的可读性有相应的影响。
• 流的操作没有关闭，在程序结束的时候没有清理资源输入流的资源。程序中缺少注释，一点注释都没有，100+的代码如果不写注释，一旦出现Bug，将很难调试。
• 功能函数在申请变量，没有判断是否成功，而直接使用变量。
• 在多条件判断是否语句中，不用多次括号代表优先级
• 增强for遍历对象集合时，没有做提前检查
• 在功能函数返回类型时void时，没有加return；做出返回

他的代码应该改进的部分

• 代码过于简单，应该有自己的思想，即使简单的功能，也应该有自己的设计模式，有自己的特色。
• 代码的缩进部分应该加强。
• 程序功能中规中矩，没有额外特色，在这方面应该加强。
• 泛型处理方面应该考虑周全，虽然高版本编译器泛型的特殊操作，但是低版本的不支持

4.结对收获

通过此次结对作业，我初步了解代码复审的要求。以前只知道代码要缩进得当。今天才发现java的审查表有60多项。而我要考虑的东西还远远不够，在审查结对同学的代码时候同时也发现了几个自己代码存在的问题。比如：不写注释，多个if elseif 后来没else，以前只觉得这些都没有什么必要，只要实现功能就行。今天才发现，如果程序的健壮性和可读性不好也会影响代码评审的结果。吕宏林的代码就是如此。通过这次结对作业，我也锻炼了和同伴一同工作。以前基本都是自己单干，现在发现如果自己单干两个人的活自己会特别累。还是和同伴一起探讨，有效率，也不会产生所谓的瓶颈。

最后附上吕宏林同学代码的细节方面的审查结果

功能模块名称	斗地主发牌功能
审查人	陈敬男	审查日期	2019.4.24
代码名称	斗地主发牌功能	代码作者	吕宏林
重要性	激活	级别	检查项
命名
重要	Y	20	命名规则是否与所采用的规范保持一致？
	N	20	是否遵循了最小长度最多信息原则？
重要	Y	50	has/can/is前缀的函数是否返回布尔型？
注释
重要	N	10	注释是否较清晰且必要？
重要	N	10	复杂的分支流程是否已经被注释？
	Y	10	距离较远的}是否已经被注释？
	Y	10	非通用变量是否全部被注释？
重要	Y	50	函数是否已经有文档注释？（功能、输入、返回及其他可选）
	N	10	特殊用法是否被注释？
声明、空白、缩进
	Y	20	每行是否只声明了一个变量？（特别是那些可能出错的类型）
重要	Y	40	变量是否已经在定义的同时初始化？
重要	N	40	类属性是否都执行了初始化？
	Y	20	代码段落是否被合适地以空行分隔？
	N	20	是否合理地使用了空格使程序更清晰？
	Y	20	代码行长度是否在要求之内？
	Y	20	折行是否恰当？
语句/功能分布/规模
	N	20	包含复合语句的{}是否成对出现并符合规范？
	Y	20	是否给单个的循环、条件语句也加了{}？
	N	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	对象使用前是否进行了检查？
重要	N	80	局部对象变量使用后是否被复位为NULL？
重要	Y	70	对数组的访问是否是安全的？（合法的index取值为[0, MAX_SIZE-1]）。
重要	Y	20	是否确认没有同名变量局部重复定义问题?
	N	20	程序中是否只使用了简单的表达式？
重要	N	20	是否已经用（）使操作符优先级明确化？
重要	N	20	所有判断是否都使用了（常量==变量）的形式？
	Y	80	是否消除了流程悬挂？
重要	Y	80	是否每个if-else if-else语句都有最后一个else以确保处理了全集？
重要	Y	80	是否每个switch-case语句都有最后一个default以确保处理了全集？
	Y	80	for循环是否都使用了包含下限不包含上限的形式？（k=0; k<MAX）
重要	Y	40	XML标记书写是否完整，字符串的拼写是否正确?
	Y	40	对于流操作代码的异常捕获是否有finally操作以关闭流对象?
	N	20	退出代码段时是否对临时对象做了释放处理?
重要	Y	40	对浮点数值的相等判断是否是恰当的？（严禁使用==直接判断）
可靠性（函数）
重要	N	60	入口对象是否都被进行了判断不为空？
重要	N	60	入口数据的合法范围是否都被进行了判断？(尤其是数组)
重要	Y	20	是否对有异常抛出的方法都执行了try...catch保护？
重要	N	80	是否函数的所有分支都有返回值？
重要	Y	50	int的返回值是否合理？（负值为失败，非负值成功）
	Y	20	对于反复进行了int返回值判断是否定义了函数来处理？
	N	60	关键代码是否做了捕获异常处理?
重要	N	60	是否确保函数返回CORBA对象的任何一个属性都不能为null?
重要	N	60	是否对方法返回值对象做了null检查，该返回值定义时是否被初始化?
重要	Y	60	是否对同步对象的遍历访问做了代码同步?
重要	Y	80	是否确认在对Map对象使用迭代遍历过程中没有做增减元素操作？
重要	Y	60	线程处理函数循环内部是否有异常捕获处理，防止线程抛出异常而退出?
	Y	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	是否把方法中的重复代码抽象成私有函数?