实验四 代码审查

实验四 代码评审
1、实验目的
1）了解代码审查的含义；
2）掌握相关编程规范检查工具的安装与使用；
2、实验内容及要求
Code Review中文应该译做“代码审查”或是“代码评审”或“代码复查”，是指经过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Code Review主要用来在软件工程过程当中改进代码质量，经过代码评审能够达到以下目的：
●在项目早期就可以发现代码中的BUG
●帮助初级开发人员学习高级开发人员的经验，达到知识共享
●避免开发人员犯一些很常见，很普通的错误
●保证项目组人员的良好沟通
●项目或产品的代码更容易维护
代码评审主要内容是编程规范，重构方法，架构设计，性能安全，日志，可读性，扩展性等问题。经过代码评审可查找和修复引入到开发阶段的应用程序的错误，提升软件的总体素质和开发者的技能。代码评审的做用和意义已在不少技术团队内达成共识，但是不少时候并未被有效执行，甚至被认为是一项费时费力的工做。借助一些工具能够更容易，更有效率地来进行Code Review。
一、以小组形式，针对前面“实验一”中所完成的代码，进行代码评审(走查)，重点检查如下状况。你也可有查询相关材料，创建更细化的检查清单（check list）

• 程序是否能正常工做，代码是否实现预期的功能，逻辑是否正确。
• 代码是否遵循的编程规范
• 代码是否尽量的模块化
• 全部的数据输入是否都进行了检查
• 是否有注释，而且描述了代码的意图
• 代码的可理解性和可测试性
  二、按“实验二”的分组方式，两人一组，随机分配另外一组的代码做为本组评审和分析的对象
  一些编码规范的检查工具以下，也可自行查找工具使用。
  java语言
• 采用使用eclipse Checkstyle插件
• CheckStyle是SourceForge下的一个项目，提供了一个帮助JAVA开发人员遵照某些编码规范的工具。它可以自动化代码规范检查过程，从而使得开发人员从这项重要但枯燥的任务中解脱出来。它能够根据设置好的编码规则来检查代码。好比符合规范的变量命名，方法体的最大行数，重复代码检查等等。
  若是你使用idea ，可使用Alibaba Java Code Guidelines插件，参考连接以下：https://github.com/alibaba/p3c/wiki/IDEA插件使用文档
  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并报告，想向项目全部人询问或用来追踪各类想法探讨准备实施的任务。

3、实验过程
（1）配置代码审查工具。要求采用屏幕截图的方式配置的过程；
（2）使用工具对原始代码进行评审和分析，记录结果，期间不要有任何修改；
（3）对工具执行结果进行人工分析，结合检查清单和人工走查的出代码修改建议；
（4）经过github issues向项目维护者提交问题(issue),注意一个issue 只报告一个问题，多个问题需放在多个issue中，以便跟踪。
（5）记录总结实验过程当中遇到的问题和解决过程
四.实验结果
（1）代码审查工具配置
代码是由采用Java编写，审查工具选择插件checkstyle。
首先下载checkstyle

打开Eclipse help->install new solftware 点击add添加

勾选checkstyle

而后finish,Eclipse开始安装插件，稍等会弹出对话框点击install away

重启Eclipse

Windows->preferendes出现checkstyle,配置成功

克隆https://github.com/Aaalua/LifeGame

（2）checkstyle进行代码审查，并记录




（3）对审查结果进行人工分析

代码能够正常运行出预期结果，可是代码大部分没有按照代码规范进行编写，运算符先后没有空格隔开，而且使用了不少的制表符tab。建议多参照Java的编码规范，包名的命名使用小写字母，尽可能不适用制表符tab，尽可能避免一行输入过多字符。
（）Github提交issues

（5）总结遇到的问题及解决方法
checkstyle配置中出现问题，第一次采用的是在线安装checkstyle，help->install new solftware 填写CheckStyle - http://eclipse-cs.sourceforge.NET/update
而后老是出错不成功。在查看别人的配置方法后，checkstyle配置成功。
实验小结
由于checkstyle不能汇总审查结果，采用人工的方法逐一分类统计比较麻烦，checkstyle适用在编写Java代码过程当中检测出不规范的编码并改正，不适合作审查代码的报告。checkstyle有两种编码规范Google和sun,本次实验采用的是Google编码规范。鉴于人工列审查清单较麻烦，因此小组采用分工合做，而后进行交流。