实验四代码评审

一、实验目的

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、Cpplint的安装

　　本次审查对象是采用C语言编写而成的四则运算程序，所以要用到Cpplint来对其进行代码审查

　　Cpplint是Google开发的一个C++代码风格检查工具，可以使用cpplint作为代码规范的一个检查工具。Cpplint是一个使用python2.X版本写的脚本，所以执行的时候只能在安装python2.X版本上面，或者也可以修改部分语法使其支持python 3，网上应该能找到修改方法，但我懒，还是重新装一个python 2.7 吧。安装python 2.7并配置环境变量之后，检查是否成功。如下图python 版本已经替换。安装过程不贴图了（忘记截了）。

　　然后我在github上找到了Cpplint.py文件，克隆下来后把它放在了python2.7的安装目录下，如下图。

　　查看Cpplint是否能正常运行，进入到python的安装目录，输入python Cpplint.py --help，测试结果如下图：

2、代码审查

　　脚本可以正常使用，接下来进行代码审查，待审查文件已经下载到本地的E盘，文件路径为，E:\TestForNow\test.cpp，通过查阅资料，我们对Cpplint的参数做了些了解：

　　(1)、对于发现的每一个问题，cpplint都会给出一个位于区间[1, 5]之间的置信度评分，分数越高就代表问题越肯定，能够通过verbose选项控制输出哪些级别。例如以下。置信度评分为1、2的将不会再输出：D:\python-2.7>python Cpplint.py --verbose=3 test.cpp

　　(2)、假设代码中有些部分不希望被检查，或者觉得是cpplint产生的误报。仅仅须要在对应代码行尾加入凝视”// NOLINT”就可以，cpplint就会跳过这些行。如：return 0; // NOLINT

　　(3)、假设须要让cpplint支持其他文件扩展，又不想改动源代码。则能够通过extensions选项如：D:\python-2.7>python Cpplint.py --extensions=hpp test.cpp

　　(4)、能够指定错误信息输出格式，支持两种格式，默认是emacs格式。还支持Visual Studio格式，能够通过output选项指定。如：D:\python-2.7>python Cpplint.py --output test.cpp 2>log.txt

　　(5)、能够通过filter选项。依照自己的须要过滤掉特定的警告，”-FOO”表示不输出带有FOO的警告，”+FOO”表示输出带有FOO的警告，如：D:\python-2.7>python Cpplint.py --filter=-whitespace/tab,+whitespace/ending_newline test.cpp

　　(6)、能够通过counting选项。来显示每种Category有多少个错误，如：D:\python-2.7>python Cpplint.py --counting=detailed test.cpp

　　(7)、能够通过linelength选项。来控制每行的最长长度，默认是80字符。假设同意每行最长长度为120，则为：D:\python-2.7>python Cpplint.py --linelength=120 test.cpp

　　我们设置了输出各类问题以及总数，部分结果如下，图2给出了所有问题的种类和出现的次数：

　　这里要说一下，最开始为了防止误报，我们设置了置信区间，使用了如下命令，输出屏蔽了置信度为1和2的错误信息，但是后来一想有可能漏掉一些问题，还不如全部输出。然后再人工去审查一遍稳妥。以下是之前的结果：

　　对比可以看出，设置了置信区间的结果少了两类错误：'whitespace/tab' errors和 'runtime/threadsafe_fn' errors，但是我们在写代码的时候也还是应该注意着两个问题的，另外两次审查都提到了'readability/utf8' errors 这个是因为使用了中文注释，根据实际问题考虑忽略这条信息。

3、问题总结

　　综上所述我们给出关于该代码的规范问题的总结如下：

　　1、Tab found; better to use spaces 最好使用空格代替Tab
　　2、Consider using rand_r(...) instead of rand(...) for improved thread safety 考虑使用rand.r（…）而不是rand（…）来提高线程安全性
　　3、Missing space before { 大括号前面缺少空格
　　4、Missing space after ; 分号后面缺少空格
　　5、Redundant blank line at the end of a code block should be deleted 代码块最后的空行应该被删除
　　6、An else should appear on the same line as the preceding } 'else'应该出现在与前一个'}'相同的行上
　　7、Missing space after , 逗号后面缺少空格
　　8、Missing spaces around = 运算符两边应该有空格
　　9、If an else has a brace on one side, it should have it on both 大括号的位置不合规范
　　10、Should have a space between // and comment 在'//'和注释之间应该有空格
　　11、No copyright message found. You should have a line: "Copyright [year] <Copyright Owner>" 缺少版权信息