软件工程 实验四 代码评审
实验四 代码评审
一、实验目的
1） 了解代码审查的含义；
2） 掌握相关编程规范检查工具的安装与使用；
二、实验内容及要求
Code Review中文应该译作“代码审查”或是“代码评审”或“代码复查”，是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Code Review主要用来在软件工程过程中改进代码质量，通过代码评审可以达到如下目的：
●在项目早期就能够发现代码中的BUG
●帮助初级开发人员学习高级开发人员的经验，达到知识共享
●避免开发人员犯一些很常见，很普通的错误
●保证项目组人员的良好沟通
●项目或产品的代码更容易维护
代码评审主要内容是编程规范，重构方法，架构设计，性能安全，日志，可读性，扩展性等问题。通过代码评审可查找和修复引入到开发阶段的应用程序的错误，提高软件的整体素质和开发者的技能。代码评审的作用和意义已在很多技术团队内达成共识，可是很多时候并未被有效执行，甚至被认为是一项费时费力的工作。借助一些工具可以更容易，更有效率地来进行Code Review。
1、以小组形式，针对前面“实验一”中所完成的代码，进行代码评审(走查)，重点检查以下情况。你也可有查询相关材料，建立更细化的检查清单（check list）
- 程序是否能正常工作，代码是否实现预期的功能，逻辑是否正确。
- 代码是否遵循的编程规范
- 代码是否尽可能的模块化
- 所有的数据输入是否都进行了检查
- 是否有注释，并且描述了代码的意图
- 代码的可理解性和可测试性
2、按“实验二”的分组方式，两人一组，随机分配另一组的代码作为本组评审和分析的对象
一些编码规范的检查工具如下，也可自行查找工具使用。
ava语言
- 采用使用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.确定所需要的代码审工具：
在GitHub中先clone我需要进行审查的项目。根据克隆的项目，发现该工程使用的是JAVA语言，所以对应我选择使用eclipse Checkstyle插件 。通过相关资料查询我发现可以直接通过eclipse中进行在线下载。
打开Eclipse，选择Help-->Eclipse Maketplace，进入搜索界面，如图：
在搜索框输入checkstyle，如图所示，点击安装即可
安装成功后，选中工程，右键可以看见：checkstyle。 点击Check Code with Checkstyle 可以进行代码审查。
（2）使用工具对原始代码进行评审和分析，记录结果，期间不要有任何修改；
1.首先在导入项目过程中该组的项目让我很疑惑，我无论怎么导入该组项目都不成功，导入不进去。我用eclipse中git功能
直接在GitHub上面clone下来也无法导入。
在询问同学后的确能将项目导入，我试了也能成功运行，但是无法采用checkstyle进行分析，因为点击分析的按钮后没有任何反应
没有办法只能新建一个项目，手动将该组项目拖入eclipse中，然后发现如图所示：
包的名字与程序中的不符，我不知道是自己操作失误还是什么情况，为了能进行代码审查，我只能修改了包的名字，才能
使实验进行下去。
分析成功：
对于该组代码的理解因为我发现与我采用的方法并不一致，而且缺少注释，甚至没有。尽管我将注释的编码从GKB改为UTF-8
还是有乱码的现象，导致我更难看懂每一部分是用来干什么的，所以在这里就不谈我对该组项目的理解了。
（3）对工具执行结果进行人工分析，结合检查清单和人工走查的出代码修改建议；
使用checkstyle进行分析后结果如下：
人工分析：
1.从上述检查清单中可以发现，审查出现大量的空格和缩进不正确的问题。
2.参考Ckeckstyle常见报错的问题，相比较而言此代码出现的问题还不是很多，而且很多都不在常见问题之中。很多都是小问题，比如符号之间留有空格等。
修改意见：
1.'=' '<'等前面没有空格，’}‘等后面没有空格；
2.对注释和代码要有正确的缩进；
3.注意大括号的使用。在大括号与其他符号相邻时，中间要留有空格；for' 和';'结构必须使用大括号 '{}'；
4.对自定义的变量，添加对应的javadoc注释；
（4）通过github issues向项目维护者提交问题(issue),注意一个issue 只报告一个问题，多个问题需放在多个issue中，以便跟踪。
（5）记录总结实验过程中遇到的问题和解决过程
实验中的问题在实验过程中基本都提到了
1.将其他组项目导入时遇到的问题，通过网上查询的方法无法导入。在询问同学的帮助下，成功的将项目导入了，但是不知道为什么项目无法被分析。
所以为了使实验进行下去，我只能新建项目，手动的将其导入，中间也出现了错误，只好将其修改。
2.部分注释出现乱码的现象，将ecplise中GKB编码改为UTF-8。
四、实验小结
1.通过本次此实验，我了解了代码审查工具的使用方法及功能，在eclipse中正确安装了Checkstyle工具，完成了对代码的审查与分析。
2.在利用CheckStyle对Java代码审查，并汇总了错误后，我在其中也对编码规范有了更多的了解。虽然本次实验中出现的错误类型并不是很多，但在总结错误类型中查阅了相关资料了解到checkstyle常见报错的问题及解决。这次实验给我留下了很深的印象因为我注意到了平时不认为是错误的地方也有代码规范问题。
3.我自身的代码方面肯定还存在相关问题，在此次学习中，希望能在日后的编码中修改，逐渐规范起来。
