实验四 代码评审

一、实验目的

1） 了解代码审查的含义；

2） 掌握相关编程规范检查工具的安装与使用；

二、实验内容及要求

Code Review中文应该译作“代码审查”或是“代码评审”或“代码复查”，是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Code Review主要用来在软件工程过程中改进代码质量，通过代码评审可以达到如下目的：

●在项目早期就能够发现代码中的BUG

●帮助初级开发人员学习高级开发人员的经验，达到知识共享

●避免开发人员犯一些很常见，很普通的错误

●保证项目组人员的良好沟通

●项目或产品的代码更容易维护

     代码评审主要内容是编程规范，重构方法，架构设计，性能安全，日志，可读性，扩展性等问题。通过代码评审可查找和修复引入到开发阶段的应用程序的错误，提高软件的整体素质和开发者的技能。代码评审的作用和意义已在很多技术团队内达成共识，可是很多时候并未被有效执行，甚至被认为是一项费时费力的工作。借助一些工具可以更容易，更有效率地来进行Code Review。

1、以小组形式，针对前面“实验一”中所完成的代码，进行代码评审(走查)，重点检查以下情况。你也可有查询相关材料，建立更细化的检查清单（check list）

- 程序是否能正常工作，代码是否实现预期的功能，逻辑是否正确。

- 代码是否遵循的编程规范

- 代码是否尽可能的模块化

- 所有的数据输入是否都进行了检查

- 是否有注释，并且描述了代码的意图

- 代码的可理解性和可测试性

2、按“实验二”的分组方式，两人一组，随机分配另一组的代码作为本组评审和分析的对象

一些编码规范的检查工具如下，也可自行查找工具使用。

三 实验内容

因为我们此次匹配到审查的小组是我们序列号下一位，经过简单的沟通，我们得知对面所用的编译语言为C++，所以我们采用Cpplint脚本

下面是Cpplint脚本的简单介绍

Cpplint是一个python脚本，Google使用它作为自己的C++代码规范检查工具，VSCcode可配置Cpplint对C++代码进行规范检查。

因为我之前的课程内学过python课程 所以我电脑上有python，版本为3.7.0

  接下来是下载脚本并安装

下载完成后进行配置

接着 我们用cpplint工具检查代码

获得以下结果

以上是自动评审所的结果

接下来是手动检测代码，查看是否有遗漏

克隆对方上传的仓库文件

打开并运行

输入老师题目的所要求的条件，查看是否符合老师的题目

接下来是将发现的问题整理并反馈

四  小结

因为我平时在编写代码的时候，经常不规范，但心里想的是反正自己能看懂，所以并未太在意，但这次通过审阅别人的代码，我意识到了规范代码编写的重要性，这还只是一个简单的程序，因为每个人编写代码的习惯不同，都已经带来了如此大的困扰，更何况以后的学习或者职业中经常会出现这种的情况。所以以后的编写代码的过程中要时刻提醒自己编写的规范性