重点检查重要部分的代码检查清单
代码审查清单以及明确的代码审查规则和准则可以使您的代码审查实践对您的团队更加有益，并显着加快了代码审查的速度。
研究表明，使用清单的代码审阅者的表现优于不使用清单的代码审阅者。 因此，无论您是新开发人员还是已经有经验的开发人员，都可以考虑使用代码审查清单。
成为您自己的代码审阅者
代码审查清单不仅对代码审查者有用。 相反，随着代码作者的更改，请遵循代码审查最佳实践，并首先成为自己的审查者！
因此，在发送代码进行审查之前，请确保：
- 该代码编译并通过静态分析而不会发出警告
- 该代码通过了所有测试（单元测试，集成测试和系统测试）
- 您已仔细检查拼写错误，并进行了清理（注释，待办事项等）。
- 您概述了此更改的含义，包括更改的原因以及更改的内容
除此之外，作为代码作者，您应与审阅者一起执行相同的代码审阅清单。
代码审查者的代码审查清单
作为代码审阅者， 寻找最重要的问题是您的任务。 挑剔比较容易。 但是，那不好。 在Microsoft进行的一项大型研究中，我们调查了出色的代码审查反馈的外观。 我们清楚地看到，揭示较大结构或逻辑问题的评论比专注于次要问题的评论更有价值。
这是代码审查清单起作用的地方。 一份出色的清单将您的注意力转移到重要且最有价值的问题上。 在下面，您可以找到一个清单，我在代码审查研讨会中也使用了该清单。 它分为十个单独的部分。 每个部分都会引导您解决几个问题。 因此，让我们开始：
实作
逻辑错误和错误
错误处理和记录
可用性和可访问性
测试与可测试性
依存关系
安全性和数据隐私
性能
可读性
专家意见
好吧，就是这样。 您查看并考虑了最紧迫的问题。 恭喜你！
现在，我在代码审查研讨会中进行的练习之一是通过回答以下三个问题来与参与者反映在代码审查清单上：
- 您最关注代码检查清单的哪些部分？
- 您倾向于忽略哪些部分？
- 您是否认为其中某些观点比其他观点更重要？ 为什么？
但是，编码风格和约定如何？
也许在本练习中，您意识到我没有检查代码是否遵循正确的编码风格。 所以，这不重要吗？
简短的回答，很重要。 清晰的编码风格指南是在代码库中保持一致性的唯一方法。 并且，一致性使代码审查更快，使人们可以轻松地更改项目，并使您的代码库可读性和可维护性。
Google是做到这一点的一个很好的例子。 无疑，这使Google拥有了斋戒的代码审查周转时间之一 。
首先，我建议使用Google 提供的多种语言的现成编码样式 。
设定基本规则很重要，但要确保一劳永逸。 不要持续争论。
清晰的编码样式可以加快代码审查的速度。 但是，仅当您通过工具自动执行它们时。 （ 点击鸣叫）
自动化什么可以自动化
但是，一旦决定了代码库的外观，就花一些时间正确安装和配置工具，以便代码格式化成为一个按钮的问题。
此外，您还可以做更多的事情。 使用静态分析工具可以节省人工代码审阅者的时间。 值得一开始的努力。
不要让您的审稿人检查工具是否可以检测到更可靠和更具成本效益的问题。 （点击鸣叫 ）
尊重，谦虚和友善
最后，代码审查反馈的质量不仅取决于您说的是什么，还取决于您说的如何。 因此，最好的代码审查反馈如果措辞不当，谦虚友善，则毫无价值。 对于初学者，请将您的反馈作为建议而不是要求。 例如，不要写“变量名应该是removeObject”。 说“如何调用变量removeObject？”。 有关更多输入，请阅读我的文章， 该文章介绍了如何提供尊重的代码审查反馈 。
还有更多适合您的……
您可以将整个清单下载为PDF或使用下面的图像。 另一份对您来说可能非常有价值的资源是我的免费代码审查电子书 。
最后，您知道我可以帮助团队进行代码审查吗？ 查看我的远程代码审查研讨会 。
先前发布在https://www.michaelagreiler.com/code-review-checklist/
From: https://hackernoon.com/a-code-review-checklist-to-focus-on-the-important-parts-au4f3ykj