我们都应该做Code Review

CR.png

这是原文作者在Google工作中总结出来的Code Review经验,非常值得我们学习.

你可以从Code Review中获得什么?

• 找到bugs.

  很多人认识到在code review中可能会找到代码的bug.但这是code review最不重要的一点,因为在code review中发现的bug通常是一些不重要的bug.处理这些bug,负责该代码的人可能只需要几分钟就会修复.真正花时间的bug不会在code review中找到.

• 最大的好处纯粹是社交

  如果你们进行CR,你知道你写的代码会被同事看到,那么你写的代码会比原来不需要进行CR时写的代码不一样.你写更加简洁,注释清楚,组织良好的代码.因为你所关心的人会评价你的代码.

• 传播知识

  在大部分的开发团队,都是每个人负责开发一个模块,而且他们只关注自己的模块.这就会导致一个问题:对于每个模块,只有一个人熟悉该模块的代码.如果负责该模块的人请假或者离开公司了,其他人会很难接手该模块.如果有CR,那么一个模块至少有2个人熟悉该模块(代码负责人跟另一个reviewer).虽然另一个reviewer的人对该模块的认识远不如模块的负责人,但是他已经熟悉了这个模块的设计还有架构,这是非常重要的.

Code Review要注意什么

• 不要批评别人的代码

  在CR中,作为一个reviewer,你的责任是要保证作者的代码是正确的,而不是如果让我来写,这代码会这样!.如果违反了这规则,那么CR会充满着挫折.

• 不要以为在Code Review中,你就一定要评论些什么

  如果在CR中,你总是在找机会去评论作者的代码,那么这只会损害的你信誉.如果你不断地去找一些话题去评论,那么作者就会知道你只是为了打破僵局,他们就不会重视你所说的.

原文地址