软件工程实验四---代码评审](https://www.cnblogs.com/elward-lv/p/12867152.html)
一、实验目的
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中采取相应的代码审查工具，在工具栏中选择Help->Eclipse MarketPlace,搜索checkstyle 进行安装。
如下图所示：
在插件的选项中:windows->perferences->checkStyle;选取google的审查配置即可，如下图：
在项目上右击选择checkstyle->check code with checkstyle开始审查代码
3.使用工具对原始代码进行评审和分析
在经过大致的审查之后，如下图所示
第一种，分号后面缺少空格
第二种，缩进不规范
第三种 else使用不规范
这三类问题也恰恰是我平常编程也经常忽略的，因此我也赶紧将自己带审查了一遍，不出意料，问题惊人的相似。
4.对工具执行结果进行人工分析，结合检查清单和人工走查的出代码修改建议
-
是否能够正常运行
能够正常运行，且运行没有发生错误
-
代码是否遵循编程的规范：
- 缩进不合理
- 存在大量无效注释
- 命名方法存在问题
- 存在变量未使用
- 库函数文件引用冗余
-
代码模块化
模块化合理清晰，便于阅读。
-
所有的数据输入是否进行了检查
此程序无数据输入
-
是否有注释，并且描述了代码的意图
存在部分注释，但并不全面，且存在多余的注释
-
代码的理解性和可测试性
代码理解比较清晰，测试也比较方便简单。
5.提交issue
由于程序不存在无法运行的情况，而且结构也比较清晰易懂，所以仅仅需要改正在上文提到的三种类型的问题即可，在与同组成员商量后提交了相应的issue。
6.记录总结实验过程中遇到的问题和解决过程
在实验过程，在阅读代码方面没有遇到什么比较困难的问题，对方的代码的可阅读性非常好，与同组成员讨论后都可以比较清楚的理解，实在遇到难以解决的问题通过QQ联系对方进行询问。
7.实验小结
在进行了这次实验的过程，我感觉就像在揪出自己平时代码中不规范的地方，可能自己平时不会注意到这些问题，但是在看到别人的代码审查结果是，心里就已经知道自己代码的状态了。总之，还需锻炼自己的代码水平啊。