软件工程第四次作业

软件工程第四次作业——代码审查

代码审查表

参考博客：JAVA代码审查
结对伙伴：徐世超
伙伴的代码地址：GitHub

重要性	级别	检查项	结果
总计
命名
重要	20	命名规则是否与所采用的规范保持一致？	N
	20	是否遵循了最小长度最多信息原则？	Y
重要	50	has/can/is前缀的函数是否返回布尔型？	N
注释
重要	10	注释是否较清晰且必要？	Y
重要	10	复杂的分支流程是否已经被注释？	N
	10	距离较远的}是否已经被注释？	N
	10	非通用变量是否全部被注释？	N
重要	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	单个函数不超过规定行数？	N
重要	100	缩进层数是否不超过规定？	N
重要	100	是否已经消除了所有警告？	Y
重要	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以确保处理了全集？	Y
重要	80	是否每个switch-case语句都有最后一个default以确保处理了全集？	Y
	80	for循环是否都使用了包含下限不包含上限的形式？（k=0; k<MAX）	N
重要	40	XML标记书写是否完整，字符串的拼写是否正确?	N
	40	对于流操作代码的异常捕获是否有finally操作以关闭流对象?	N
	20	退出代码段时是否对临时对象做了释放处理?	N
重要	40	对浮点数值的相等判断是否是恰当的？（严禁使用==直接判断）	Y
可靠性（函数）
重要	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

代码审查总结

　　本次代码审查我的伙伴给我提供的是一段实现回调的代码模块，是一段JAVA代码。于是我在网上查阅了JAVA的的代码审查，并学习到了很多JAVA编程中容易遇到的问题，以及解决问题的方法。在之前的学习中我们进行的很多的代码编写，但是代码规范却没有一个标准。只知道通过程序得到自己想要的结果就算通过了，却不知代码审查。
　　在课程学习中，我了解到代码审查的重要性。通过学习，我认为代码审查可以进一步规范我们的代码，使程序结构清晰美观。可以找出代码中的逻辑错误、算法错误等。也可以找出代码中不够优的地方进行改进。在本次代码审查中我发现伙伴的一些问题，比如变量名、函数名是否标准，程序中是否有繁琐没用的代码部分。一边看他的代码，我一边看代码审查表，我边看会边想我的代码编程时是否也做到了。审查伙伴的代码同时审查自己。
　　代码审查过程中我发现，编写代码时应该像我们安静的在图书馆里读一本有趣的故事书一样。代码中一些浅显的问题的产生就像一些画面需要我们自己去联想，当你联想到了在编写时就会想办法注意这个问题。不要在大的构思已经完成时，又回过头去进行修修补补，少了可能还可以，太多的修补可能会带来很多不可预料的问题。有很多BUG的产生我们不知道在哪里的问题，通过代码审查可以帮助我们减少它的产生机会。
　　我想代码的审查，不仅可以增强代码的规范，也可以让审查者有很多学习的机会。让他学习别人的解决方式的思路，以此来开阔思路。学习别人的优点，更好的完善自己

转载于:https://www.cnblogs.com/1148510216yong/p/8717081.html