实验四代码审评

一、实验目的

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插件使用文档

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并报告，想向项目所有人询问或用来追踪各种想法探讨准备实施的任务。

三、实验过程

3.1. 配置代码审查工具
首先，我们在github上进入我们要审查的代码所在的仓库，然后fork目标仓库并clone到自己的本地文件夹中

3.2 好的接下来，我们开始安装代码审查工具，由于是.cpp文件，所以我们采用cpplint进行代码审查。

经过自己搜索发现，.cpplint既可以支持py2.x和py3.x，所以一般来说，3.x的py也是支持的，但是在运行过程中，可能出现某些错误。

这里的cpplint呢，我们在github上进行安装

(https://github.com/cpplint/cpplint)

然后我也很奇怪为什么需要配置，可能是别人需要集成到vs或者vscode中，这里我们直接在cmd中运行，应该可以不需要进行配置.

好的，所有的东西都下载好了之后就是这样的一个界面，接下来我们就开始进行代码审查了。

(https://www.jianshu.com/p/f15106e8a3bf)使用方法我是参照这篇文章来的

cd到目标文件夹中我们输入python cpplint.py (目标代码)

3.3 结果记录

经过审查我们发现代码中不规范的地方比较多，这也反映出我们写代码时，严重的不规范问题。

我们队对结果进行了一次分析，发现，代码中最多不规范的地方是缩进的问题

例如1.Tab found; better to use spaces 问题原因是没有使用四个空格代替缩进，而这样的不规范之处达到了106次

2.Should have a space between // and comment 应该在//和注释之间有一个空格

3.missing spaces around = 原因是=左右缺少空格符,其实其他operator左右也应该加上空格，例如>,<之类。

4.Consider using rand_r(...) instead of rand(...) for improved thread safety.考虑使用rand_r（…）而不是rand（…）来提高线程安全性。

5.{ should almost always be at the end of the previous line "{"在前一行的末尾

6.line contains invalid UTF-8(or Unicode repalcement character) 没太懂啥意思，也没有搜到答案，或许是用unicode替代utf-8编码吧

7.```line ends in whitespaces,consider deleting these extra spaces`` 删除一行末尾的空格

3.4 修改意见

经过整理这些不规范的错误之后，提出自己的修改意见
1.代码缩进问题，尽量避免使用制表符

  2.代码和注释之间需要有良好的规范

  3.代码中含有未能解析的utf-8编码

  4.符号前后需要加空格一遍于阅读

  5.函数后面或者if语句后面的括号应当放在一行的末尾

3.5 提交issues

通过github issues向项目维护者提交问题(issue),注意一个issue 只报告一个问题，多个问题需放在多个issue中，以便跟踪。

4.实验小结

经过本次试验，我学会了如何使用cpplint工具对我们的c，c plus plus 代码进行规范性审查。也遇到了各种各样的问题。

而我也会想，这是不是我们都会犯得错误的，我们在写代码的过程中比较注重结果和功能的实现，并未能重视代码的规范和整洁性问题。

但其实，这种规范性是和结果是处于同样重要的地位的。

其次，因为刚接触这个工具，还有许多其他的功能没能体验到，接下来会逐步去尝试玩一玩的