1) 了解代码审查的含义;
2) 掌握相关编程规范检查工具的安装与使用;
Code Review中文应该译作“代码审查”或是“代码评审”或“代码复查”,是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Code Review主要用来在软件工程过程中改进代码质量,通过代码评审可以达到如下目的:
●在项目早期就能够发现代码中的BUG
●帮助初级开发人员学习高级开发人员的经验,达到知识共享
●避免开发人员犯一些很常见,很普通的错误
●保证项目组人员的良好沟通
●项目或产品的代码更容易维护
代码评审主要内容是编程规范,重构方法,架构设计,性能安全,日志,可读性,扩展性等问题。通过代码评审可查找和修复引入到开发阶段的应用程序的错误,提高软件的整体素质和开发者的技能。代码评审的作用和意义已在很多技术团队内达成共识,可是很多时候并未被有效执行,甚至被认为是一项费时费力的工作。借助一些工具可以更容易,更有效率地来进行Code Review。
1、以小组形式,针对前面“实验一”中所完成的代码,进行代码评审(走查),重点检查以下情况。你也可有查询相关材料,建立更细化的检查清单(check list)
- 程序是否能正常工作,代码是否实现预期的功能,逻辑是否正确。
- 代码是否遵循的编程规范
- 代码是否尽可能的模块化
- 所有的数据输入是否都进行了检查
- 是否有注释,并且描述了代码的意图
- 代码的可理解性和可测试性
2、按“实验二”的分组方式,两人一组,随机分配另一组的代码作为本组评审和分析的对象
一些编码规范的检查工具如下,也可自行查找工具使用。
1.克隆对象的仓库
找到对象的仓库后将其fork下来,然后在本地仓库中进行克隆。
2.安装审查插件
可以发现对方使用的代码时java,对于Java代码的审查需要用到eclipse check style,上网查询后在https://sourceforge.net/projects/eclipse-cs/中可以进行下载,
下载完成后可以进入eclipse进行插件的安装
(1)首先进入Eclipse,然后点击上方工具栏中的help,找到其中的Install New Software点击进入则会出现如图的大弹窗;
(2)点击上方的add添加该插件;
(3)在Location那一栏添加刚才下载的插件的路径;
(4)将该插件取名为CheckStyle;
插件安装成功后就可以进行代码的审查了
3.代码审查
黄色背景的代码即时存在一定问题的代码
4.总结及提交issue
1.代码中普遍存在大量的缩进问题,影响并不大
2.main函数应及时关闭
3.部分符号存在使用错误
4.创建类时缺少Javadoc
5.提交issues
这次的实验不仅让我们学习了如何针对不同语言编写的代码,采用不同的插件进行代码审查,同时也让我意识到了自己平时在写代码时存在着很多不好的习惯,
这些都让我受益匪浅。
原文:https://www.cnblogs.com/Hypocrise/p/12888041.html