发布时间:2020-06-23
在工作中,我们都要进行代码审查。每个人都知道代码审查,每个人都会做代码审查。代码审查的目标,其中,除了找出被审查代码中的质量这一主要目标外,通过执行这些审查还可以实现:提高代码质量;保持项目的一致性;发现 bug;通过他方查找代码中的小错误,防止这些小错误日积月累腐蚀代码等等。
代码审查是一种好方法,它可以保持软件的可维护性,并在软件投入生产之前发现 bug。
由此,软件测试小编总结了以下几条代码审查的最佳方式:
1. 单独提交代码清理命令(重新格式化或修复拼写错误等)和重构。
不建议将重新格式化与重构混合到一起。如果你想重构代码,那么请注意用正确的格式。如果代码中只有与重构相关的变更,那么代码审查会容易得多。当代码中出现大量基本上只是清理命令的变更时,我们有时很容易忽略小的变化。
2. 编写相关的提交说明
务必确保你的提交注释可以很好地向审查者说明提交的内容,还有尤其要说明代码变更的原因。如果你的设计受到了很大限制,也一定要写好说明。
提交说明中如果漏掉了什么重要的信息总是令人恼火,相反,清晰明了的提交注释也会令人心情愉悦。通常在审核代码遇到问题时,就可以试着看能否从提交注释中找到答案。
3. 只提交准备好审查的代码
因此,请确保你的代码通过了所有测试。另外,在让别人审查你的代码前,先进行自我审查,仔细看看你提交的代码差异。
4. 审查期间不要更改代码
这种做法会给审查者带来更多压力,以致中断审查进度。如果你想修改审查过程中发现的问题,那么请确保在接受审查的代码基础上再另建一份提交。如此一来,审查者就可以在现阶段审查完成后,再来看你新修改的代码。最终,在所有审批都确认后,你可以将所有的提交压缩成一个。
回顾被审查者的工作,我们可以得出一个结论,即不要给审查者制造不必要的麻烦当属代码审查过程中被审查者的最佳行为准则:
确保你的代码通过了自己的审查,并且你没有发现任何明显的问题,可以放心地合并代码(如果你发现了问题,并想讨论某些内容,那么提前跟你的审核者打招呼);代码中没有混合不相干的变更,不会太长也不会增加阅读难度;针对代码变更写好提交注释,明确交待变更的目的。
代码审查工具辅助审查
我们把我们个人最喜欢的东西保存到最后,因为可以说没有比基于软件的代码审查工具更简单、更有效的方式来审查代码了,软件工具解决了上述方法的许多局限性,以清晰一致的顺序跟踪同事的评论和缺陷的建议解决方案,使得评论能够异步和非本地进行,当新的评论出现时,向原始编码人员发出通知,并保持整个过程高效运行,无需召开会议,也无需任何人离开办公桌。一些工具还允许审查和修订需求文档,重要的是,还可以生成关键使用统计数据,提供流程改进和合规性报告所需的审计试验和审查指标。
CodeAnalyzer(简称CA)是上海泽众软件科技有限公司自主研发的专业代码质量管理的代码审查软件,用于实现静态分析、代码走查、代码规范检查以及代码潜在错误分析的白盒测试工具,它是一种脱离编译器的代码静态分析软件产品。
推荐阅读:
您的信息已成功提交!
我们的客服人员稍后会与您联系