一、实验目的
1) 了解代码审查的含义;
2) 掌握相关编程规范检查工具的安装与使用;
二、实验内容及要求
Code Review中文应该译作“代码审查”或是“代码评审”或“代码复查”,是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Code Review主要用来在软件工程过程中改进代码质量,通过代码评审可以达到如下目的:
●在项目早期就能够发现代码中的BUG
●帮助初级开发人员学习高级开发人员的经验,达到知识共享
●避免开发人员犯一些很常见,很普通的错误
●保证项目组人员的良好沟通
●项目或产品的代码更容易维护
代码评审主要内容是编程规范,重构方法,架构设计,性能安全,日志,可读性,扩展性等问题。通过代码评审可查找和修复引入到开发阶段的应用程序的错误,提高软件的整体素质和开发者的技能。代码评审的作用和意义已在很多技术团队内达成共识,可是很多时候并未被有效执行,甚至被认为是一项费时费力的工作。借助一些工具可以更容易,更有效率地来进行Code Review。
1、以小组形式,针对前面“实验一”中所完成的代码,进行代码评审(走查),重点检查以下情况。你也可有查询相关材料,建立更细化的检查清单(check list)
- 程序是否能正常工作,代码是否实现预期的功能,逻辑是否正确。
- 代码是否遵循的编程规范
- 代码是否尽可能的模块化
- 所有的数据输入是否都进行了检查
- 是否有注释,并且描述了代码的意图
- 代码的可理解性和可测试性
2、按“实验二”的分组方式,两人一组,随机分配另一组的代码作为本组评审和分析的对象
j三、实验过程
(1)配置代码审查工具。要求采用屏幕截图的方式配置的过程;
如下图就是代码审查工具的使用方法
添加名称Checkstyle,并添加网址
选择如图所示开始审查
(2)使用工具对原始代码进行评审和分析,记录结果,期间不要有任何修改;
所记录的结果都已经写在对方GitHub的issue里了。
对方GitHub地址:https://github.com/3170701118/-
(3)对工具执行结果进行人工分析,结合检查清单和人工走查的出代码修改建议;
基本上都是代码格式问题,需要在以后的编码中注意。
(4)通过github issues向项目维护者提交问题(issue),注意一个issue 只报告一个问题,多个问题需放在多个issue中,以便跟踪。
(5)记录总结实验过程中遇到的问题和解决过程
刚开始,也不懂。运行对方代码时竟出现的很多warning,后来发现是我们没有看到对方写的README.md
实验小结
第一次做代码审查方面的实验,还是很有趣的。之前从没想过竟然有软件可以帮助审查代码规范,这样节省的人力。我发现大多数的不规范都是缩进、空格问题。如果是人工审查该代码就应该不会有这么多问题。工具审查就比较精益求精,一点点小瑕疵都会发现。所以编写代码不仅仅要追求没有error,也要注意书写规范!