UML软件工程组织

代码评审的最佳实践

 

2008-01-21 作者:xiekai 来源:blogjava.net

 

没有人否认code review(代码评审、复查) 对提高代码质量的作用,但是如何进行code review? 这里 确实存在一些方法和技巧。方法不当,会浪费大量时间、造成低效率;流程过紧,会大大降低生产力,流程过松,会大大降低code review的效果,甚至有没有进行code review,都很难判断。

这里有几条代码复审的最佳实践:

 一次检查适量行数代码(多少行为适量?有待检讨)
  有足够的时间、以适当的速度、仔细地检查,但不宜超过60~90分钟
  在复审前,代码作者应该对代码进行注释
  使用检查表(checklist)肯定能改进双方(作者和复审者)的结果
  验证缺陷是否真正被修复
  管理人员要营造良好的氛围(文化),使大家可以积极地对待缺陷的发现,发现足够多的缺陷,只关心问题是什么、怎样引起的,而不关心是谁写的代码
  即使没有时间完成所有代码的检查,也应该尽可能去做,哪怕是一部分
  轻量级的code review是高效率的、可行的,并能有效地发现缺陷