一、实验目的
1) 了解代码审查的含义
2) 掌握相关编程规范检查工具的安装与使用
二、实验内容及要求
Code Review中文应该译作"代码审查"或是"代码评审"或"代码复查",是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Code Review主要用来在软件工程过程中改进代码质量,通过代码评审可以达到如下目的:
●在项目早期就能够发现代码中的BUG
●帮助初级开发人员学习高级开发人员的经验,达到知识共享
●避免开发人员犯一些很常见,很普通的错误
●保证项目组人员的良好沟通
●项目或产品的代码更容易维护
代码评审主要内容是编程规范,重构方法,架构设计,性能安全,日志,可读性,扩展性等问题。通过代码评审可查找和修复引入到开发阶段的应用程序的错误,提高软件的整体素质和开发者的技能。代码评审的作用和意义已在很多技术团队内达成共识,可是很多时候并未被有效执行,甚至被认为是一项费时费力的工作。借助一些工具可以更容易,更有效率地来进行Code Review。
1、以小组形式,针对前面"实验一"中所完成的代码,进行代码评审(走查),重点检查以下情况。你也可有查询相关材料,建立更细化的检查清单(check list)
- 程序是否能正常工作,代码是否实现预期的功能,逻辑是否正确。
- 代码是否遵循的编程规范
- 代码是否尽可能的模块化
- 所有的数据输入是否都进行了检查
- 是否有注释,并且描述了代码的意图
- 代码的可理解性和可测试性
2、按"实验二"的分组方式,两人一组,随机分配另一组的代码作为本组评审和分析的对象
一些编码规范的检查工具如下,也可自行查找工具使用。
因为审查对象使用Java语言,所以 采用使用eclipse Checkstyle插件
CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要但枯燥的任务中解脱出来。它可以根据设置好的编码规则来检查代码。比如符合规范的变量命名,方法体的最大行数,重复代码检查等等。
三、实验过程:
实验对象:生命游戏 https://github.com/wbr1224/LifeGame
(1)在GitHub中使用git clone 命令克隆到本地,对审查的代码进行克隆,运行,检查。
(2)、使用eclipse Checkstyle插件对实验代码进行审查,不能使用个人名义对其进行任何的修改,保持公正性。
(3)、对于使用checkstyle之后进行人工分析,并结合检查清单和人工走查,得出下列结果;
(4)由于程序之中并较多错误,所以按照一些编程的规范,通过github 向项目维护者提交些许建议:
小结:
起初安装checkstyle较难,在网上看了很多案例之后,才将插件安装好。此次实验较为顺利,该组程序并没有什么错误,能够正确运行,只是注释少了些,有些不理解的地方只能直接问开发者,之后条理和自己的思路变清晰了许多,总之此次实验学习到了很多东西,也与同学进行了很好的沟通与交流。