首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >执行代码评审的最有效方法是什么?

问执行代码评审的最有效方法是什么?
EN

Software Engineering用户
提问于 2010-09-07 17:21:48
回答 13查看 20.6K关注 0票数 73

我从未找到过执行代码评审的理想方法,但我的客户经常需要它们。每个客户似乎都是以不同的方式进行的,我从来没有对其中的任何一个感到满意。

您执行代码评审的最有效方法是什么?

例如:

  • 是一个人被认为是质量和审核代码的看门人,还是团队拥有这个标准?
  • 您是否使用投影仪作为团队练习来检查代码?
  • 是亲自完成,还是通过电子邮件或工具完成?
  • 为了确保代码质量,您是否避免审查并使用像对编程和集体代码所有权之类的东西?
EN

回答 13

Software Engineering用户

发布于 2010-10-26 21:46:36

在我的工作中,我们有一个非常简单的规则:更改必须由至少一个其他开发人员在合并或提交到主干之前进行审查。在我们的例子中,这意味着另一个人会和你一起坐在你的电脑前,并查看更改列表。这不是一个完美的系统,但它仍然明显地提高了代码质量。

如果您知道您的代码将被审查,这迫使您首先查看它。那时,许多问题变得明显起来。在我们的系统中,您必须向审阅者解释您所做的事情,这再次使您注意到您以前可能没有注意到的问题。此外,如果您的代码中的某些内容对审阅者没有立即明确,这是一个很好的指示,表明需要更好的名称、注释或重构。当然,审查员也可能会发现问题。此外,除了查看更改之外,审阅者还可能注意到附近代码中的问题。

这种制度有两个主要的缺点。当变化是微不足道的,它是没有意义的审查它。不过,我们绝对要坚守规则,避免在不改变的情况下,宣布改变是“微不足道”的滑坡路。另一方面,这不是一个很好的方式来审查系统的重大变化或添加大量的新组件。

我们曾经尝试过更正式的评审,当一个开发人员将电子邮件代码发送到团队的其他成员,然后整个团队会聚在一起讨论这个问题。这花费了每个人的大量时间,因此这些评论很少,而且只有一小部分代码库被审查过。“另一个人在提交之前检查更改”对我们来说效果要好得多。

票数 32
EN

Software Engineering用户

发布于 2010-09-07 17:51:35

我喜欢代码评审,尽管它们可能会很痛苦。我喜欢他们的原因是他们更多地关注代码和不同的视角。我认为,即使是对编程,代码也应该被审查。对于处理同一代码的两个人来说,可以很容易地集体地犯相同的错误,这是不同的一组人可能不会错过的。

如果作为一个小组与投影仪,它真的应该在会议之前进行单独的审查。否则,这只是一种恼人的浪费时间。

我只通过电子邮件和小组进行了代码评审。一般说来,我认为不应该亲自去做。你会感到更大的压力,让你在别人回头看的情况下匆匆完成代码。我确实认为,为代码评审设计的工具将是一个好的资产,因为它可以帮助一些平凡的方面,它应该使标记问题代码比特变得更容易,然后是通过电子邮件。

让一个人做所有代码评审的问题是,这可能是一个瓶颈。有了详细的文档和设计的编码标准,就不应该有必要了。根据环境/发布时间表的不同,让某人作为备用代码审阅者可能是个好主意。

我确实认为代码所有权是一个好主意,因为这个人可以将理解代码作为他们的优先事项,并可能扮演守门人的角色。

票数 13
EN

Software Engineering用户

发布于 2010-10-27 16:08:11

在SmartBear,我们不仅制作代码评审工具,而且每天都使用它。这是我们发展过程中必不可少的一部分。我们检查每一个被签入的变更。

我认为有一个单一的门卫代码审阅者是个坏主意,原因很多。这个人成了瓶颈,他们必须做太多的代码评审(仅仅是为了保持项目的运行),才能真正有效(一次60-90分钟是效率的极限)。代码评审是分享想法和知识的好方法。无论你的守门员是多大的超级明星,他们都可以向团队中的其他人学习。此外,让每个人都进行代码评审也会创建一个“集体代码所有权”环境--人们觉得自己拥有代码的质量(不仅仅是QA或看门人)。

我们有一个关于"同行代码评审的最佳实践“的免费白皮书,其中有11条使代码评审有效的提示。这本书的大部分内容都是约翰以一种更精练的形式提到的。

票数 7
EN
页面原文内容由Software Engineering提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://softwareengineering.stackexchange.com/questions/1224

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档