如何做好代码评审并赢得同事的认可?

2025-06-10

如何做好代码评审并赢得同事的认可?

代码审查不仅能提高代码质量,也是互相学习和分享经验的绝佳工具。进行代码审查并非易事。指责或批评同事和同行并非人们日常所乐见的。因此,以建设性和积极的方式进行审查,对审查者和被审查者都有益。

准备:

1)遵守编码指南或与您的团队成员一起制定编码指南。

使用正确的词语:

2) 避免使用负面词语和评论,例如“删除”、“更改”、“不需要”、“不”、“不好”、“我不喜欢这个”等。3
) 不要使用讽刺。4
) 避免将代码称为“我的”、“你的”或“他们的”。5
) 提问而不是命令。使用诸如“你认为这样会更好吗?”“你觉得……怎么样?”之类的问题
。6) 保持积极的态度。不要说“我没有这样做”、“这不是我做的”等话。

阐明:

7) 解释你评论背后的原因以及它将如何改进代码。8
) 清晰地表达你的观点并提供论据。如有需要,请提供其他代码片段或 PR 的链接。9
) 如果代码不清楚,请要求澄清。如果问题太多,最好当面询问。10
) 反馈要清晰。如果需要大量讨论,可以另行安排讨论。

接受:

11) 从评论中学习,并了解其他人如何解决同样的问题。12
) 不要将其视为针对个人的问题,代码审查是针对代码本身,而不是针对你本人。13
) 接受所有反馈。无论你是初级还是高级,都要积极地接受反馈。14
) 对其他编写代码或方法的方式持开放态度。15
) 不要将反馈变成持续的争论。你可以随时与评论者当面沟通。

支持:

16) 提供支持。通过结对编程或提供示例来提供帮助。17
) 积极响应。在当天或之后提供更多信息或说明。18
) 速度要快。不要留下太多未完成的 Pull Request。代码库会不断增长,PR 也会被保留下来。19
) PR 被接受后,给予积极的反馈,例如使用“点赞”表情符号或说“太棒了,做得好”之类的话。20
) 如果反馈有帮助,请告知审阅者你认为它有何帮助。例如,使用“好主意,谢谢”之类的话……

建设性且积极的代码审查能够培养健康的工作文化,让团队成员能够自由表达,无需担心羞辱和负面反馈。这将营造一个让团队成员感到受尊重、受重视且高效的环境。最终,它将促进敏捷开发、知识共享和个人成长。

鏂囩珷鏉ユ簮锛�https://dev.to/samizan/how-to-make-good-code-reviews-and-win-colleagues-2dc8
PREV
Kristina Balaam 谈闯入安保部门
NEXT
编码面试中所有重要的数据结构和算法