1) 了解代码审查的含义;
2) 掌握相关编程规范检查工具的安装与使用;
二、实验内容及要求
Code Review中文应该译作“代码审查”或是“代码评审”或“代码复查”,是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Code Review主要用来在软件工程过程中改进代码质量,通过代码评审可以达到如下目的:
●在项目早期就能够发现代码中的BUG
●帮助初级开发人员学习高级开发人员的经验,达到知识共享
●避免开发人员犯一些很常见,很普通的错误
●保证项目组人员的良好沟通
●项目或产品的代码更容易维护
代码评审主要内容是编程规范,重构方法,架构设计,性能安全,日志,可读性,扩展性等问题。通过代码评审可查找和修复引入到开发阶段的应用程序的错误,提高软件的整体素质和开发者的技能。代码评审的作用和意义已在很多技术团队内达成共识,可是很多时候并未被有效执行,甚至被认为是一项费时费力的工作。借助一些工具可以更容易,更有效率地来进行Code Review。
1、以小组形式,针对前面“实验一”中所完成的代码,进行代码评审(走查),重点检查以下情况。你也可有查询相关材料,建立更细化的检查清单(check list)
- 程序是否能正常工作,代码是否实现预期的功能,逻辑是否正确。
- 代码是否遵循的编程规范
- 代码是否尽可能的模块化
- 所有的数据输入是否都进行了检查
- 是否有注释,并且描述了代码的意图
- 代码的可理解性和可测试性
2、按“实验二”的分组方式,两人一组,随机分配另一组的代码作为本组评审和分析的对象
一些编码规范的检查工具如下,也可自行查找工具使用。
三、实验内容
(1):下载并配置Cpplint
Cpplint下载地址:https://github.com/cpplint/cpplint
因为我之前就使用过python3.7版本,并且配置过python的环境;所以我只需要把下载好的文件夹放到python的安装文件夹底下。结果如图:
下载界面:
已经安装过,并配置好环境:
将cpplint文件夹放到python安装路径下:
(2):用cpplint工具检查代码
最后显示有299个errors,这些错误大多是格式问题,当然也有部分代码优化问题。在下面我已经将错误总结出来。
(3):手动检查代码
手动运行代码后发现该程序只能一次性出好题目;研究代码后发现代码所出题目不能整除,不能答题,故也不能判断对错。题目界面不整齐。已经和他们反映代码问题。
(4):通过github向代码作者提交issue(最好一个问题提交一个issue,以便后面的错误修改)
四、实验小结
这此实验的难度并不大,刚开始我手动检查了一下他们的代码,发现代码不全之后通知他们补全;代码的作者也很给力,反映之后很快就好了。然后因为我之前已经安装好了python所以我只用下载工具之后,把工具放到python的安装路径下就可以了。这个工具强大的判别能力让我有点惊讶,细微的错误都可以发现,还带有代码效率方面的优化。用好这个工具确实对我们很有用。
原文:https://www.cnblogs.com/zgh083417/p/12888847.html