实验四代码评审

一、实验目的

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

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

二、实验内容及要求

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

java语言

- 采用使用eclipse Checkstyle插件

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

C++语言

- 可使用Google代码规范工具Cpplint。

- Cpplint是一个python脚本，Google使用它作为自己的C++代码规范检查工具，VSCcode可配置Cpplint对C++代码进行规范检查。

python

- 可采用pylint

- Pylint 是一个 Python 代码分析工具，它分析 Python 代码中的错误，查找不符合代码风格标准（Pylint 默认使用的代码风格是 PEP 8，具体信息，请参阅参考资料）和有潜在问题的代码。目前在 eclipse 的 pydev 插件中也集成了 Pylint，VSCcode可安装pylint插件

当发现了项目存在的问题后，可通过Bug跟踪系统向项目维护者反馈问题（issue）,管理Issue的系统称为BTS（Bug Tracking System，Bug跟踪系统）。当今具有代表性的BTS有Redmine、Trac、BugZilla等。GitHub自身也加入了BTS的功能。在GitHub上，可以将它作为软件开发者之间的交流工具。通过github的issues功能开发者可以便捷的发现软件的BUG并报告，想向项目所有人询问或用来追踪各种想法探讨准备实施的任务。

三、实验过程

（1）配置代码审查工具。要求采用屏幕截图的方式配置的过程；

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

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

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

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

（1）配置代码审查工具

https://sourceforge.net/projects/eclipse-cs/进入此网站下载eclipse Checkstyle。

下载完成后，打开下载的压缩文件，分别将features和plugins文件夹下的文件拷贝到eclipse安装目录下的features和plugins文件夹中，如图

重启eclipse，preferences里可以看见Checkstyle，即安装成功。

（2）（3）使用工具对原始代码进行评审和分析，修改建议

选中你的包，project下的properties，勾选Checkstyle active for this project.开始代码审查。

包命名要规范，包名应为indi.发起者名.项目名.模块名*.*.\*

不应使用.*的形式导入包。应为import java.awt.event.ActionEvent;

导入包要符合字典顺序。应为

类名首字母应大写其余的为小写，方法和{之间应有空格。tab键不应随意使用，在不同的IDE、编辑器（例如EditPlus、UltraEdit等）中使用的空格数不同，因此为了统一，开发人员统一使用4个空格代替tab键（checkstyle会配置做相应检查）。

缩进不规范，子内容缩进应为两个空格。

注释应放在语句体内，注释的为下一条语句，注释应和注释的语句有同样的缩进，运算符左右要加空格。应为

应在方法的上部加入javadoc注释，缩进应规范。应为

if、while 等关键字后要加空格，运算符左右之间要用空格分开，成员变量缩进两个，方法要缩进两个。注释是注释在上方。tab键在不同的IDE、编辑器（例如EditPlus、UltraEdit等）中使用的空格数不同，因此为了统一，开发人员统一使用4个空格代替tab键（checkstyle会配置做相应检查）。