我对如何进行良好的代码审查的看法。

我的建议

我们为什么要进行代码审查？

代码审查，顾名思义，就是让其他开发人员有机会查看并审查你提交的代码。

代码审查是开发生命周期的关键要素之一。如果没有代码审查，质量差或存在缺陷的代码可能会进入用户验收测试 (UAT)，从而拖慢测试/发布流程。

我的建议

仔细评论单词

请记住，您正在审查的人的代码可能已经为这项工作付出了很多努力，并且他们并没有故意犯错误，特别是那些容易错过的拼写错误等。

留言时尽量不要太伤人。

不要太过强硬地提出意见或建议。例如，与其说

更改此变量名称

像这样说：

也许可以将其表述为更具描述性的变量名。

这样就提出了改进的建议，但让程序员觉得他们仍然有发言权/问题仍有待讨论。

清晰、简洁。

直截了当地说明你想要改变什么或建议什么。不要喋喋不休，拐弯抹角，只需说明“是什么”和“为什么”。

如今，大多数 git 系统都允许您单击要更改的行，并添加注释，因此指定要更改的确切代码行变得更加简单。

GitHub 等托管服务提供商具有“建议”功能，允许您直接在评论中添加代码建议，该建议可以在 PR 中立即被接受和提交。

同一类型的多个更改。

无需对问题的每一个出现进行评论（这可能会让程序员不知所措。只需添加一条评论并解释问题发生在多个文件中，并建议查找所有出现的情况并进行更新，例如拼写错误或重复的代码。

不是每个人都像你一样编码

请记住，每个人的编码方式都不一样，而且肯定不会总是和你一样。这并不意味着他们是错的，也不意味着你的方式是最好的。

总是退一步思考代码审查的关键要素。

• 代码是否遵循团队的编码指南

• 代码是否满足其目标/验收标准。

• 代码是否清晰易懂，无需大量注释/文档就能理解其功能。（对我来说，这一点至关重要，因为我非常喜欢描述性的方法名和变量名。）

• 考虑到安全性、性能或简单的易读性，代码是否需要重构。

• 代码是否遵循简单的设计模式/原则，例如单一职责、抽象、封装等。如果没有，请就如何实现这一点提出建议，或者告诉那些不熟悉它的人它的含义和好处。

这些是我的一些建议，希望它们对您有所帮助。

请在评论中随意讨论您的代码审查技巧和方法。