实验四 代码评审

一、实验目的

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、配置代码审查工具（要求采用屏幕截图的方式配置的过程）

　　（1）本次实验审查的小组信息及项目地址如下：

49/Freunde 纪超超 https://www.cnblogs.com/aspic/ 刘莹 https://www.cnblogs.com/lldkla/ 生命游戏https://github.com/DKLA5/software-test.git

　　（2）由于该小组编写项目所用的编码语言为C++，所以采用cpplint评审编码规范。 

下载cpplint.py文件：https://github.com/google/styleguide

下载python-2.7.18：https://www.python.org/ 

　　配置过程：♦下载cpplint.py源码，并将其存放到D:\cpplint中；♦下载python-2.7.18.msi，安装python，并将D:\ProgramFiles\Python27 添加到系统环境变量Path中。　　

　　

　　

　　

2、使用工具对原始代码进行评审和分析（记录结果，期间不要有任何修改）

　　（1）cpplint的操作参考博文如下：

https://blog.csdn.net/Csdn_Darry/article/details/72791475

　　（2）从项目仓库将文件 game.cpp下载到目录D:/tmp/下，打开cmd，输入下述命令：

D:\cpplint\cpplint.py D:\tmp\game.cpp

　　！！！注意cpplint.py文件和game.cpp文件的地址。　　

　　（3）审查结果如下：

 　　（4）由上述所示共有144个错误，10种错误类型，具体分析如下：

 　　（5）修改建议

　　该项目代码没有什么语法错误，基本上都是书写格式上的一些不规范。参考建议如下：

　　♦添加项目代码的版权信息

　　♦避免使用中文的注释（由于cpplint是Google的编码规范，个人认为中文注释更适合我们阅读代码）

　　♦统一使用四个空格代替缩进

　　♦避免代码行后面存在空格、代码块后面存在空行

　　♦运算符的前后、标点符号的后面、代码和注释之间以及方法名和括号之间注意要有空格

　　♦避免出现大于80字符的行

　　♦文件末尾要有换行符

　　（6）通过GitHub向第49组同学的项目提交issue。（一个问题对应一个issue，有利于监督）

 

四、实验中遇到的问题及解决

1、【Q】在寻找C++的代码审查工具时就遇到不少问题，因为cpplint,py是依赖于python2的，而我的计算机之前安装的python3，所以就在寻求其他的审查工具，但是要么是审查效果不好，要么需要收费。

     【A】最终还是选择了cpplint，下载version2.7的python。

2、【Q】第一次使用cpplint时，输入参考博文中相同的命令是没有出现结果

　　

     【A】问了同组的队员，将命令改为D:\cpplint\cpplint.py D:\tmp\game.cpp，注意cpplint.py文件和game.cpp文件的地址要写全。

3、【Q】一开始结果显示有144个错误，统计错误类型比较繁琐。

     【A】通过查找资料，输入命令D:/cpplint/cpplint.py --counting=detailed D:/tmp/game.cpp，可以直接出现分类结果。

　　

五、实验小结

1、大学写过不少代码，但是从来没有涉及到代码规范审查。本次实验让我认识到对于编码而言，语法和逻辑固然重要，但是编码规范在项目协作中是可以直接影响到工作效率的。增强代码的可读性是很重要的事情。

2、对cpplint的使用还不是很熟练，做完实验找了资料了解了一些关于cpplint更多的操作：

(1)对于发现的每一个问题，cpplint都会给出一个位于区间[1, 5]之间的置信度评分，分数越高就代表问题越肯定，能够通过verbose选项控制输出哪些级别。例如以下。置信度评分为1、2的将不会再输出：
E:\tmp>python D:/soft/Cpplint/cpplint.py --verbose=3 test.cpp
(2)假设代码中有些部分不希望被检查，或者觉得是cpplint产生的误报。仅仅须要在对应代码行尾加入凝视”// NOLINT”就可以，cpplint就会跳过这些行。如：
return 0; // NOLINT
(3)假设须要让cpplint支持其他文件扩展，又不想改动源代码。则能够通过extensions选项如：
E:\tmp>python D:/soft/Cpplint/cpplint.py --extensions=hpp test.cpp
(4)能够指定错误信息输出格式，支持两种格式，默认是emacs格式。还支持Visual Studio格式，能够通过output选项指定。如：
E:\tmp>python D:/soft/Cpplint/cpplint.py --output test.cpp 2>log.txt
(5)能够通过filter选项。依照自己的须要过滤掉特定的警告，”-FOO”表示不输出带有FOO的警告，”+FOO”表示输出带有FOO的警告，如：
E:\tmp>python D:/soft/Cpplint/cpplint.py --filter=-whitespace/tab,+whitespace/ending_newline test.cpp
(6)能够通过counting选项。来显示每种Category有多少个错误，如：
E:\tmp>pythonD:/soft/Cpplint/cpplint.py --counting=detailed test.cpp
(7)能够通过linelength选项。来控制每行的最长长度，默认是80字符。假设同意每行最长长度为120，则为：
E:\tmp>python D:/soft/Cpplint/cpplint.py --linelength=120 test.cpp
选项的更具体说明信息请參考cpplint.py。

【参考资料】

　　cpplint,py的下载：https://github.com/google/styleguide

　　python2.7的下载：https://www.python.org/ 

　　cpplint的使用：https://www.jianshu.com/p/f15106e8a3bf

　　　　　　　　　https://www.cnblogs.com/liguangsunls/p/7136467.html

　　　　　　　　　https://blog.csdn.net/Csdn_Darry/article/details/72791475