一、实验目的
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）配置代码审查工具。要求采用屏幕截图的方式配置的过程；
1.1确定代码审查工具
在GitHub页面clone待审查的项目，在README.md中发现该小组使用的软件为eclipse，故选择eclipse的checkstyle为代码审查工具。
1.2自动安装checkstyle
在eclipse的帮助——安装新软件中输入checkstyle插件的下载安装地址，进行自动安装
正在自动安装：
根据提示重启eclipse：
在窗口——首选项中查看是否显示checkstyle，若显示，则成功安装了checkstyle。
（2）使用工具对原始代码进行评审和分析，记录结果，期间不要有任何修改；
2.1导入待审查项目
在GitHub上clone待审查项目，并导入到本地eclipse中，运行项目：
项目可以正常运行。
2.2使用checkstyle进行代码审查
右击待审查项目，使用check style进行代码审查：
但是在使用右键——check style检查后，没有任何反应，起初以为是插件安装出错，故重新安装，并没有解决问题。
之后我更改了待测试项目，使其不规范，checkstyle可以显示其不规范之处：
（3）对工具执行结果进行人工分析，结合检查清单和人工走查的出代码修改建议；
由于自动审查原项目并没有产生任何结果，而在我修改项目故意使其不规范之后可以检查出不规范之处，可以得出结论：
待审查项目的代码完全符合规范，无需修改。
（）记录总结实验过程中遇到的问题和解决过程
实验中遇到的最大的问题就是右键使用checkstyle审查代码之后没有任何反应，上网搜索相关资料也没有找到有帮助的信息，估计是由于我没有正确配置插件而导致出错，之后我重新安装了checkstyle插件，并重新配置，还是没有解决问题。而在我修改项目故意使其不规范之后可以检查出不规范之处，说明待审查项目的代码完全符合规范，无需修改。
实验小结：
通过此次实验，我了解了代码审查的重要性，也学习了eclipse上checkstyle插件的使用方法，以后编写程序，我都会使用此类的代码审查软件，让自己编写的代码更加规范。