如何处理审查者的评论

针对掌握处理Code Review中审查者评论的技巧。本文提供了一套实践技巧,包括如何解读评论、进行有效沟通以及采取适当行动,以实现更顺畅、更具生产力的审查过程。

当你发送 CL 进行审查时,你的审查者可能会对你的 CL 发表一些评论。以下是处理审查者评论的一些有用信息。

明白一个道理:这不是针对你

审查的目标是保持代码库和产品的质量。当审查者对你的代码提出批评时,请将其视为在帮助你、代码库和 Google,而不是对你或你的能力的个人攻击。

有时,审查者会感到沮丧并在评论中表达他们的挫折感。对于审查者来说,这不是一个好习惯,但作为开发人员,你应该为此做好准备。问问自己,“审查者试图与我沟通的建设性意见是什么?”然后像他们实际说的那样操作。

永远不要愤怒地回应代码审查评论。这严重违反了专业礼仪且将永远存在于代码审查工具中。如果你太生气或恼火而无法好好的回应,那么请离开电脑一段时间,或者做一些别的事情,直到你感到平静,可以礼貌地回答。

一般来说,如果审查者没有以建设性和礼貌的方式提供反馈,请亲自向他们解释。如果你无法亲自或通过视频通话与他们交谈,请向他们发送私人电子邮件。以友善的方式向他们解释你不喜欢的东西以及你希望他们以怎样不同的方式来做些什么。如果他们也以非建设性的方式回复此私人讨论,或者没有预期的效果,那么请酌情上报给你的经理。

修复代码

如果审查者说他们不了解你的代码中的某些内容,那么你的第一反应应该是澄清代码本身。 如果无法澄清代码,请添加代码注释,以解释代码存在的原因。 只有在想增加的注释看起来毫无意义时,你才能在代码审查工具中进行回复与解释。

如果审查者不理解你的某些代码,那么代码的未来读者可能也不会理解。在代码审查工具中回复对未来的代码读者没有帮助,但澄清代码或添加代码注释确可以实实在在得帮助他们。

自我反思

编写 CL 可能需要做很多工作。在终于发送一个 CL 用于审查后,我们通常会感到满足的,认为它已经完成,并且非常确定不需要进一步的工作。这通常是令人满意的。因此,当审查者回复对可以改进的事情的评论时,很容易本能地认为评论是错误的,审查者正在不必要地阻止你,或者他们应该让你提交 CL。但是,无论你目前多么确定,请花一点时间退一步,考虑审查者是否提供有助于对代码库和对 Google 的有价值的反馈。你首先应该想到的应该是,“审查者是否正确?”

如果你无法回答这个问题,那么审查者可能需要澄清他们的意见。

如果你已经考虑过并且仍然认为自己是正确的,请随时回答一下为什么你的方法对代码库、用户和/或 Google 更好。通常,审查者实际上是在提供建议,他们希望你自己思考什么是最好的。你可能实际上对审阅者不知道的用户、代码库或 CL 有所了解。所以提供并告诉他们更多的上下文。通常,你可以根据技术事实在自己和审查者之间达成一些共识。

解决冲突

解决冲突的第一步应该是尝试与审查者达成共识。 如果你无法达成共识,请参阅“代码审查标准”,该标准提供了在这种情况下遵循的原则。

本文是否对你有用?

内容导航