软件工程实验四---代码评审
一、实验目的
1）了解代码审查的含义；
2）掌握相关编程规范检查工具的安装与使用；
二、实验内容及要求
Code Review中文应该译作“代码审查”或是“代码评审”或“代码复查”，是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Code Review主要用来在软件工程过程中改进代码质量，通过代码评审可以达到如下目的：
-
在项目早期就能够发现代码中的BUG
-
帮助初级开发人员学习高级开发人员的经验，达到知识共享
-
避免开发人员犯一些很常见，很普通的错误
-
保证项目组人员的良好沟通
-
项目或产品的代码更容易维护
代码评审主要内容是编程规范，重构方法，架构设计，性能安全，日志，可读性，扩展性等问题。通过代码评审可查找和修复引入到开发阶段的应用程序的错误，提高软件的整体素质和开发者的技能。代码评审的作用和意义已在很多技术团队内达成共识，可是很多时候并未被有效执行，甚至被认为是一项费时费力的工作。借助一些工具可以更容易，更有效率地来进行Code Review。
1、以小组形式，针对前面“实验一”中所完成的代码，进行代码评审(走查)，重点检查以下情况。你也可有查询相关材料，建立更细化的检查清单（check list）
-
程序是否能正常工作，代码是否实现预期的功能，逻辑是否正确。
-
代码是否遵循的编程规范
-
代码是否尽可能的模块化
-
所有的数据输入是否都进行了检查
-
是否有注释，并且描述了代码的意图
-
代码的可理解性和可测试性
2、按“实验二”的分组方式，两人一组，随机分配另一组的代码作为本组评审和分析的对象
当发现了项目存在的问题后，可通过Bug跟踪系统向项目维护者反馈问题（issue）,管理Issue的系统称为BTS（Bug Tracking System，Bug跟踪系统）。当今具有代表性的BTS有Redmine、Trac、BugZilla等。GitHub自身也加入了BTS的功能。在GitHub上，可以将它作为软件开发者之间的交流工具。通过github的issues功能开发者可以便捷的发现软件的BUG并报告，想向项目所有人询问或用来追踪各种想法探讨准备实施的任务。
一些编码规范的检查工具如下，也可自行查找工具使用。本次实验使用eclipse的checkStyle插件来完成代码审查
三.实验过程
1.检查对象
仓库地址：https://github.com/localhost999/shengmingyx
2.配置代码审查工具
在eclipse中搜索对应的插件即可，如下图：
在插件的选项中:windows->perferences->checkStyle;选取google的审查配置即可，如下图：
然后在项目上右击选择checkstyle->check code with checkstyle；即可开始审查代码。
3.使用工具对原始代码进行评审和分析
大致的审查，分了类之后的结果如下：
-
The static field window.jPanel should be accessed in a
static way
-
This method has a constructor name
-
Missing Javadoc Method: 缺少 Javadoc 。
-
Indentation: 'ctor def' 子元素缩进了8个缩进符，应为4个。
-
The value of the local variable life is not used
-
The method stop() from the type Thread is deprecated
-
The import java.util.Random is never used
-
Left Curly Brace Placement: 第 5 个字符 '{' 应位于前一行。
4.对工具执行结果进行人工分析，结合检查清单和人工走查的出代码修改建议
- 是否正常工作:
是，运行几次均没有错误 - 代码是否遵循的编程规范：
-
代码冗余：一部分代码去除之后仍然可以正常运行
-
主要有一些变量从未使用 如:suanfa.class->方法 judge()里的life
-
命名有点问题 如：main.class 中静态方法main和构造函数命名相同
-
静态方法的调用不合理
-
使用了某些不推荐使用的方法，如Thread.stop();
-
库引入不规范 ，引入了很多没有用到的库文件
-
缩进不合理
-
- 代码是否尽可能的模块化：
- 程序进行了模块的处理，GUI和线程属于一个类的模块，刷新和算法属于另外一个类的模块
- 所有的数据输入是否都进行了检查：
- 没有输入数据
- 是否有注释，并且描述了代码的意图：
- 有一些注释，但是并不全面，还有一些部分没有注解，没有表明作用
- 代码的可理解性和可测试性：
- 代码测试很方便，因为没有输入需要测试，而且只要运行main函数即可
5.提交issue
由于程序并没有严重的错误，所以只需要提交一些编程规范的修改意见即可，可以按照上述的分类提交对应的issue。
6.记录总结实验过程中遇到的问题和解决过程
实验很顺利，程序没有什么大问题。开始时理解代码的时候有些代码没有理解，于是就直接问作者具体的代码实现；还有开始并不会使用checkstyle，从网上搜索了一些文档才完成了相关插件的安装和测试。
