1)了解代码审查的含义;
2)掌握相关编程规范检查工具的安装与使用;
Code Review中文应该译作“代码审查”或是“代码评审”或“代码复查”,是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Code Review主要用来在软件工程过程中改进代码质量,通过代码评审可以达到如下目的:
在项目早期就能够发现代码中的BUG
帮助初级开发人员学习高级开发人员的经验,达到知识共享
避免开发人员犯一些很常见,很普通的错误
保证项目组人员的良好沟通
项目或产品的代码更容易维护
代码评审主要内容是编程规范,重构方法,架构设计,性能安全,日志,可读性,扩展性等问题。通过代码评审可查找和修复引入到开发阶段的应用程序的错误,提高软件的整体素质和开发者的技能。代码评审的作用和意义已在很多技术团队内达成共识,可是很多时候并未被有效执行,甚至被认为是一项费时费力的工作。借助一些工具可以更容易,更有效率地来进行Code Review。
1、以小组形式,针对前面“实验一”中所完成的代码,进行代码评审(走查),重点检查以下情况。你也可有查询相关材料,建立更细化的检查清单(check list)
程序是否能正常工作,代码是否实现预期的功能,逻辑是否正确。
代码是否遵循的编程规范
代码是否尽可能的模块化
所有的数据输入是否都进行了检查
是否有注释,并且描述了代码的意图
代码的可理解性和可测试性
2、按“实验二”的分组方式,两人一组,随机分配另一组的代码作为本组评审和分析的对象
当发现了项目存在的问题后,可通过Bug跟踪系统向项目维护者反馈问题(issue),管理Issue的系统称为BTS(Bug Tracking System,Bug跟踪系统)。当今具有代表性的BTS有Redmine、Trac、BugZilla等。GitHub自身也加入了BTS的功能。在GitHub上,可以将它作为软件开发者之间的交流工具。通过github的issues功能开发者可以便捷的发现软件的BUG并报告,想向项目所有人询问或用来追踪各种想法探讨准备实施的任务。一些编码规范的检查工具如下,也可自行查找工具使用。本次实验使用eclipse的checkStyle插件来完成代码审查
三、实验过程
3.1本次实验审查的代码仓库地址为:https://github.com/paxifaer/pp_project
3.2下载并安装checkStyle插件,从百度直接搜索checkStyle,进入官网下载,下载成功后,将下载好的文件中的features和plugins文件夹中的文件分别复制到Eclipse所在目录下的features和plugins文件夹下,重启Eclipse即完成了checkStyle插件的安装。
3.3 从要审查的代码的地址仓库中下载其项目文件,导入到Eclipse中:
3.4使用工具对原始代码进行评审和分析
选择导入的项目工程,右击选择checkStyle-->Check code with checkstyle就可以对代码进行审查,大致审查结果如下:
3.5.对工具执行结果进行人工分析,结合检查清单和人工走查的出代码修改建议
1.程序可以正常运行
2.代码规范
从代码本身来看,代码没有任何问题,主要存在两点不规范的地方:
1)代码导入不规范导致提示
2).代码的制表符使用不够规范的提示
3.代码模块化
代码模块清易理解,没有什么问题
4.代码注释
代码的注释清晰明了,使代码阅读起来更加容易
5.代码的可理解性和可测试性
代码测试很方便,运行界面也做的很不错
6.提交issue
实验中由于我检查的小组是直接fork的原选题仓库并在forkd的仓库下新建分支提交项目的,没有重新建立新的仓库,导致我无法找到 issue选项进行提交issue。
四、总结
实验前半部分很顺利,程序没有什么大问题,对于该小组的一些代码规范性问题也已经在报告中提出,后面由于检查的小组仓库的问题未能如期完成issue的提交,但实验目的基本达到。通过本实验学到了代码审查的相关内容,开始并不会使用checkstyle,从网上寻找一些资料才完成了相关插件的安装和测试,掌握使用方法之后非常便捷。
原文:https://www.cnblogs.com/YWQLCc/p/12887203.html