实验四 代码评审

一、实验目的

1） 了解代码审查的含义；

2） 掌握相关编程规范检查工具的安装与使用；

二、实验内容及要求

Code Review中文应该译作“代码审查”或是“代码评审”或“代码复查”，是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Code Review主要用来在软件工程过程中改进代码质量，通过代码评审可以达到如下目的：

●在项目早期就能够发现代码中的BUG

●帮助初级开发人员学习高级开发人员的经验，达到知识共享

●避免开发人员犯一些很常见，很普通的错误

●保证项目组人员的良好沟通

●项目或产品的代码更容易维护

 代码评审主要内容是编程规范，重构方法，架构设计，性能安全，日志，可读性，扩展性等问题。通过代码评审可查找和修复引入到开发阶段的应用程序的错误，提高软件的整体素质和开发者的技能。代码评审的作用和意义已在很多技术团队内达成共识，可是很多时候并未被有效执行，甚至被认为是一项费时费力的工作。借助一些工具可以更容易，更有效率地来进行Code Review。

1、以小组形式，针对前面“实验一”中所完成的代码，进行代码评审(走查)，重点检查以下情况。你也可有查询相关材料，建立更细化的检查清单（check list）

• 程序是否能正常工作，代码是否实现预期的功能，逻辑是否正确。

• 代码是否遵循的编程规范

• 代码是否尽可能的模块化

• 所有的数据输入是否都进行了检查

• 是否有注释，并且描述了代码的意图

• 代码的可理解性和可测试性

2、按“实验二”的分组方式，两人一组，随机分配另一组的代码作为本组评审和分析的对象

一些编码规范的检查工具如下，也可自行查找工具使用。

java语言

• 采用使用eclipse Checkstyle插件

• CheckStyle是SourceForge下的一个项目，提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程，从而使得开发人员从这项重要但枯燥的任务中解脱出来。它可以根据设置好的编码规则来检查代码。比如符合规范的变量命名，方法体的最大行数，重复代码检查等等。

如果你使用idea ，可以使用Alibaba Java Code Guidelines插件，参考链接如下：https://github.com/alibaba/p3c/wiki/IDEA插件使用文档

三、实验过程

（1）配置代码审查工具。要求采用屏幕截图的方式配置的过程；
使用eclipse工具检查java代码，需要下载CheckStyle工具，下载地址：http://sourceforge.net/projects/eclipse-cs/
完成相应的解压操作，并且将关键文件放入Eclipse根目录下

在dropins文件夹里新建.link文件，输入路径

保存、重启eclipse，出现如图所示，代表link成功

在Project点右键，可以对代码进行check，在windows-> perfermance -> CheckStyle可以进行导入配置文件

（2）使用工具对原始代码进行评审和分析，记录结果，期间不要有任何修改；

使用checkstyle工具

结果：

行号	提示
2	import前应有空行
很多	行内有制表符tab
22	'method def modifier' 缩进了8个缩进符，应为2个。
26	'if' 结构必须使用大括号 '{}'。
30	缺少 Javadoc 。
48	'try' 缩进了16个缩进符，应为4个。
60	'while' 子元素缩进了24个缩进符，应为6个。

（3）对工具执行结果进行人工分析，结合检查清单和人工走查的出代码修改建议；
人工分析

经过检查，代码执行正常，可以完成相应的功能

问题	建议
缩进不符合规范	对不合规范的缩进进行修改
if没有使用大括号	在if中使用大括号结构
import前没有空一行	在package和import之间留出一行

（4）通过github issues向项目维护者提交问题(issue),注意一个issue 只报告一个问题，多个问题需放在多个issue中，以便跟踪。

（5）记录总结实验过程中遇到的问题和解决过程

1. 刚开始的时候，CheckStyle无法安装，后来经过检查，发现是下载的文件出现了问题，CheckStyle默认自带两种代码规范格式，sun和google，如果需要建立自己的代码规范，可以在Windows->performance->checkstyle导入外部的格式
2. 由于一开始进行实验一和实验二的时候，没有要求使用何种规范，导致了很多地方都存在不符合规范的地方
3. 人工评审的时候，有些代码在自己的机器上无法运行，经过检查，发现是配置的运行环境不同导致的，以及在eclipse中运行程序，需要注意将package和class的文件名修改成代码中对应的文件名
4. 出现了注释无法显示的问题，原因是使用的编码格式不同

四、实验总结

1. 通过这次实验我了解代码审查的含义，明白了在编写代码的过程中，不仅需要确保功能能够正常的执行，也需要保证代码的格式符合规范，合理的对代码进行模块化设计、合理的撰写注释都是提高代码质量必不可少的步骤。
2. 掌握了CheckStyle的下载方式和安装方法，在eclipse中学会了如何调试checkstyle以及如何使用。
3. 将来的编程过程中，需要注意对自己的代码进行合理的设计，包括模块化，规范注释，进行输入检查，这些会有助与自己代码质量的提升。