一、实验目的
1) 了解代码审查的含义;
2) 掌握相关编程规范检查工具的安装与使用;
二、实验内容及要求
Code Review中文应该译作“代码审查”或是“代码评审”或“代码复查”,是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Code Review主要用来在软件工程过程中改进代码质量,通过代码评审可以达到如下目的:
●在项目早期就能够发现代码中的BUG
●帮助初级开发人员学习高级开发人员的经验,达到知识共享
●避免开发人员犯一些很常见,很普通的错误
●保证项目组人员的良好沟通
●项目或产品的代码更容易维护
代码评审主要内容是编程规范,重构方法,架构设计,性能安全,日志,可读性,扩展性等问题。通过代码评审可查找和修复引入到开发阶段的应用程序的错误,提高软件的整体素质和开发者的技能。代码评审的作用和意义已在很多技术团队内达成共识,可是很多时候并未被有效执行,甚至被认为是一项费时费力的工作。借助一些工具可以更容易,更有效率地来进行Code Review。
1、以小组形式,针对前面“实验一”中所完成的代码,进行代码评审(走查),重点检查以下情况。你也可有查询相关材料,建立更细化的检查清单(check list)
2、按“实验二”的分组方式,两人一组,随机分配另一组的代码作为本组评审和分析的对象一些编码规范的检查工具如下,也可自行查找工具使用。
三、实验过程
(1)配置代码审查工具。要求采用屏幕截图的方式配置的过程;
(2)使用工具对原始代码进行评审和分析,记录结果,期间不要有任何修改;
(3)对工具执行结果进行人工分析,结合检查清单和人工走查的出代码修改建议;
(4)通过github issues向项目维护者提交问题(issue),注意一个issue 只报告一个问题,多个问题需放在多个issue中,以便跟踪。
(5)记录总结实验过程中遇到的问题和解决过程
1.配置代码审查工具。要求采用屏幕截图的方式配置的过程
1.1 首先fork他们的仓库
1.2 在github上找到了评审工具cpplint的代码
https://github.com/google/styleguide/blob/gh-pages/cpplint/cpplint.py
1.3 发现官方的代码是用的python2的语法,不支持python3,于是参考了修改源码的博客。
https://www.cnblogs.com/jiu0821/p/10760288.html
2.使用工具对原始代码进行评审和分析,记录结果,期间不要有任何修改
2.1 使用工具对代码进行评审,发现居然出现了588处错误,那不得提交588个issues,那不得疯了。于是对错误进行分析,发现有很多错误是空格不对导致的,去仓库查看了代码,果然是。
仓库源代码
2.2 于是在网上找控制cpplint输出参数的博客,参考了下篇博客。
https://blog.csdn.net/yelu_hong/article/details/83856306
2.3 加上过滤空格错误的代码,果然加上参数后输出结果变成了3个,加上空格错误一共4个,这就很nice了。
3.对工具执行结果进行人工分析,结合检查清单和人工走查的出代码修改建议
0行: No copyright message found.
未声明版权信息;应有一行申明版权
9行: Found C system header after C++ system header.
在C++头文件后找到C语言头文件;正确顺序应为:.h,c,c++,其他。头文件声明顺序有时会影响冲突内容,以先声明的为主
301行: Consider using rand_r(...) instead of rand(...) for improved thread safety.
考虑使用rand_r(…)而不是rand(…)以此提高线程安全性
4.通过github issues向项目维护者提交问题(issue),注意一个issue 只报告一个问题,多个问题需放在多个issue中,以便跟踪
5.记录总结实验过程中遇到的问题和解决过程
运行他们代码发现有一处错误,参数i重定义了。提醒他们重新更新仓库。
实验小结
cpplint是一个python脚本,Google使用它作为自己的C++代码规范检查工具。本次实验用cpplint工具评审了别人写的代码,学习了评审代码的过程,评审代码同时也对自己编程规范有提醒作用。