构建有效的代码审查清单需要注意哪些事项?

代码审查是保持高水平代码质量的有效方式。代码审查不仅可以作为查找问题代码的门槛，而且可以激励编码人员提高技能、学习和审查自己的工作。

现实情况是，大多数编程人员都没有一个正式的代码审查清单。并且清单很可能是自己创建的，而并非是所有程序员和公司团队统一讨论设计并使用的，因此很可能存在缺陷。

为什么要使用清单?

代码审查需要根据情况进行变化。如果没有根据实际情况进行变化，那么很可能遗漏一些重大缺陷。通过使用清单有助于评审者关注重要的内容，并在大的事情上找到变化的内容。

什么时候应该使用代码审查清单?

清单可以用来改进代码检查的工具，也可以是公司开发和安全团队构建的日常习惯。无论出于哪种作用，清单都可以被提交代码进行编码设查的程序员和安全人员使用。

准备代码是一个重要的步骤，审查清单可以帮助程序员在将代码交给安全人员之前更客观地查看他们的代码，同时在安全编码方面起到提醒程序员的作用。

建立有效的代码审查清单的重要提示

注意长度

在构建代码审查清单时要考虑到清单长度。如果清单太短，就不可能覆盖所有重要的事情，但如果太长，又很可能因为太乏味而遭到忽略。长度应该根据团队规模来确定，根据经验，一般涉及3-5个主要问题和另外7-10个较小的问题。

从基础开始

代码审查清单可能会涉及很多问题，有些问题很长，有些涉及范围很广，但最重要的是从基础开始，确保涉及的主题足够宽泛和基础。但通过清单来确定代码设计的好坏是没有意义的，反而可以通过了解编写代码的原因及项目来提供新的视角来审查代码。

情感代码与有效代码

一旦理解了代码的作用，就应该想到：代码更改是否简单有效地实现了目标?相信大家都非常保护自己的代码，因此不愿意放弃曾经的工作去寻找其他不同的解决方案。但是如果发现更有效的代码更改建议，则应该让程序员注意到这点。

有效沟通

如何在代码审查清单中传达建议并且容易被接受是一项重要的事情。代码审查并不是为了展示优越性或者引起冲突，而是为了让代码尽可能更好。

不要忽略依赖项

代码评审中一个经常被忽视的部分是依赖项。很容易忽略一个新的依赖项或包中不属于它的代码。把这个项目列在清单上，可以确保没有遗漏这个问题。这也可以使代码审查更快，因为任何依赖关系的问题都可以由编码人员在提交代码进行审查之前解决。

迭代和改进

清单通常都不是一成不变的，就像软件或者其他方面的设计一样，代码审查清单应该随着时间的推移而改进。在会议议程中从每个人那里获得对清单改进的反馈，使其随着代码库增加而增长。

创建正确的代码检查清单，需要对可用的检查清单做一些研究，并将它们拆开。找到与公司设计相关的项目，并将它们整合在一起。

对于刚开始构建清单的团队来说，第一次就构建完美的代码审查清单是不现实的。不断找出需要审查的错误并添加到清单中来防止其出现，并且删掉不会产生任何变化的项目，在审查过程中不断优化清单内容，并提高软件代码质量，获得协作性更强的团队。

文章来源：

https://blog.checkpoint.com/2022/04/08/code-review-checklist-8-steps-to-improved-productivity/