一、实验目的
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%E6%8F%92%E4%BB%B6%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3
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.克隆对象仓库
我们首先需要寻找到所需评审的代码的仓库，然后克隆到本地。
如上图则是我们这一小组需要评审的代码，将它克隆下来
克隆完成后发现对方使用的Java语言，所以我们决定使用eclipse Checkstyle插件
2.安装评审插件
一开始我们并不知道该使用什么插件以及如何去安装使用，通过查阅资料和浏览其他同学的博客才得知需要使用eclipse Checkstyle插件。然后在同学的博客中找到了该插件的下载地址（https://sourceforge.net/projects/eclipse-cs/）。我们将其下载了下来然后百度安装方法一步步进行安装。
（1）首先进入Eclipse，然后点击上方工具栏中的help，找到其中的Install New Software点击进入则会出现如图的大弹窗；
（2）点击上方的add添加该插件；
（3）在Location那一栏添加刚才下载的插件的路径；
（4）将该插件取名为CheckStyle；
（5）一切准备就绪后点击下面的Add，然后弹窗消失，此时插件怎在安装，稍等片刻会弹出另一个弹窗如下；
（6）选择Install anyway后会继续安装，然后安装完成后重启软件即安装完成。
3.评审代码
插件安装完成后即可开始进行代码评审。
（1）先打开Eclipse软件，导入刚才克隆下来的代码；
（2）运行代码，看是否能正常运行；
如图所示，可以正常运行。
（3）将鼠标移至Java项目上点击右键选择CheckStyle->Check Code with CheckStyle，系统将会自动进行代码审查；
审查完成后会出现黄色背景，出现黄色背景则表示该行代码有问题，可以将光标移至代码前的放大镜上会显示出该行代码的问题；
3.评审完成后总结的问题
代码评审完成后，我们总结了一下有四种类型的问题
（1）‘CLASS_DEF’前应有空格
（2）缩进问题，基本上每行代码都有缩进问题
（3）’import‘前应有空行
（4）Resource leak：建议及时关闭资源
4.提交问题
通过github issues向项目维护者提交问题(issue).
四、实验总结
这次实验收获巨大，让我学会了如何去使用代码评审软件。在评审其他组的代码的时候能够了解到容易出现的问题，警示自己以后写代码要注意此类问题。而且评审完别人的代码后我们又评审了一下自己这组的代码，果然出现的问题也很多。这个过程让我们牢牢记住了写代码时易犯的错误，以后能多加注意。