如何处理评审者的评论

当你提交了一个变更做代码评审时,很可能你都会收到评审者在变更中的评论。这里有一些处理这些评论的建议。

不要掺杂个人情感

代码评审的目标是维护代码库和产品的质量。如果评审者批评了你的代码,可以理解为他们在帮你、帮整个代码库、甚至是帮整个公司,而不是攻击你或者是质疑你的能力。

有时候评审者会情绪低落,然后在评论中说出一些令人沮丧的话,虽然评审者这样做不对,但作为开发者你应当有心理准备。问问你自己,“评审者试图与我交流的建设性意见是什么?” 然后照他们说的那些去做。

永远不要回应充满怒气的评论,代码评审工具中违反职业礼仪的情况永远存在。如果你真的忍无可忍,建议先离开电脑一会儿,或者干一些其他的事,等心情平复下来再回复。

通常,如果评审者没有以礼貌的方式提供反馈,请亲自向他们解释。如果你无法亲自或者通过视频和他们联系,就向他们发一份私人邮件。 友好地告诉他们你不喜欢的事情以及你希望他们做些什么。 如果他们也以非建设性的方式对此私密讨论做出回应,或者没有起到预期的作用,请酌情上报给您的经理。如果他们已经以不礼貌的方式回应,或者没有取得预期的效果,视情况汇报给你的经理。

修复代码

如果评审者说他们理解不了你代码中的某些内容,你首先应该把代码写清晰。如果让代码更清晰,添加注释来解释清楚代码的逻辑。 如果评论似乎毫无意义,那么您的答复应该只是代码查看工具中的解释。

如果评审者无法理解你的某部分代码,那边可能未来的阅读者也可能理解不了。在代码评审工具中回应帮不了未来的读者,但是代码中的注释可以。

自我反思

写一个变更会花费你很大的精力,提交代码评审时会感觉如释负重,而且自己也相当确定所有工作已经做完了。所以当评审者提出改进建议时,你很容易认为那些都是错的,或者认为是评审者给你不必要的阻挠,再或者觉得评审者应该让你提交变更。 无论如何,不管你怎么想,花点时间回想下评审者给你的反馈有助于提升公司的代码质量。你始终问下自己“如果评审者是对的呢?”

如果你回答不了评审者的问题,那可能说明评审者的评论不够清楚。

如果你认真考虑过后依旧认为你是对的,放心大胆地解释清楚为什么你的方法对公司更有利。通常,评审者只是提供建议,并且希望你能思考出更好的方法。也许你已经知道一些评审者不知道的关于用户、代码库、或者变更,把这些都写下来,给评审者更多的上下文信息,通常你都可以根据某些事实和评审者达成某些共识。

解决冲突

解决冲突的第一步,和你的评审者达成共识,如果无法达成共识,参阅代码评审的标准获取更多内容。

Last updated