实验四 代码评审

一、实验目的

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

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

二、实验内容及要求

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

三、实验过程

审查对象：https://github.com/Leo-wj123/my-travel-plans （第29组）

1、获得审查对象文件（这里直接在github上download下来）并进行功能测试

程序无报错，功能基本实现：

2.配置代码审查工具。（在python27的环境下使用cpplint进行代码审查）

在官网下载python27并进行环境配置

测试配置是否成功：

这里使用pip install的方法进行在线安装，可能会遇到网络问题（服务器响应超时下载失败）建议更换网络 或者在github下载程序进行离线安装。

这里的warning是提示更新pip版本 可忽略。

3、使用cpplint对原始代码进行评审和分析，记录结果

注意：cpplint不支持中文路径会报错，在使用前请修改文件路径以及文件名为英文。

 通过审查，存在一定规范问题（这里指Google C++代码规范）以及安全性问题。

4、对工具执行结果进行人工分析，结合检查清单和人工走查的出代码修改建议

通过查阅资料可以获得报错的原因：

 这里的 Line contains invalid UTF-8错误是在google c++规范中不允许出现中文字符，这里考虑实际情况可忽略。

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

6、记录总结实验过程中遇到的问题和解决过程

• 使用控制台进行pip install cpplint进行安装时，出现网络未响应的问题，后更换网络解决
• cpplint的对象路径存在中文时会出现报错，后将路径以及文件名修改为英文解决