编写惊人的代码检查清单

代码审查是软件开发过程中的必要组成部分，旨在减少技术负担并确保整个代码库的一致性。 编写代码的每个人都会犯错误，但是在它们投入生产并开始造成损害之前，务必将其捕获。

确保代码审查尽可能简单有效的最佳方法是创建一个涵盖您已同意的所有内容的代码审查清单，这对于确保代码的可维护性很重要。 这可能包括确保遵循最佳实践，检查代码格式是否有错误，确保测试使用最新提交是最新的以及实施团队的编码约定和策略。 创建代码审查清单意味着您，整个团队都将获得关于代码质量的统一参考点，这将有助于简化代码审查流程并确保该流程尽可能完善。

没有一种适合所有代码审查清单的大小。 每个开发人员和团队都有针对其代码的不同要求，因此请不要将本文用作唯一指南。 我们写这篇文章是为了帮助您了解我们认为好的代码质量检查表中最重要的组成部分，您可以在构建自己的清单时参考这些组成部分。

初始点

为了开始，我们需要首先考虑核心清单元素。 首先，重要的是检查代码的实现，并确保代码以高效，简洁的方式执行已编写的任务。 如果您觉得可以编写一个较短的解决方案，或者实现效率不高，则应在完成清单的其余部分之前对其进行更改。

确保您还检查了所有不再运行但已在以前的提交和构建中使用的代码。 这样可确保您的代码库干净整洁，便于团队理解，并有助于加快调试过程。

您还应该考虑检查代码的整体性能。 例如，是否有任何库可以替换功能或增强您的代码？ 是否有解决方案可以减少对其他功能的需求？ 检查以确保调试阶段是否还剩下任何代码（例如日志或旧功能），然后将其删除以确保您的代码尽可能快地运行。

代码重复

这个问题比您想象的普遍得多。 花一些时间查找在多个功能中执行相同操作的任何代码副本，如果是这种情况，请创建自己的方法。 这可能仅对于两个实例是可以接受的，但是，如果将相同的代码复制到5个不同的文件中，它们执行的功能完全相同，则应将其重构为一个统一的函数。

造型

您的代码不仅应该高效，而且还应该易于他人理解，以便任何新开发人员都可以轻松了解每行代码的用途。 在某些地方，您的代码可能需要更改，删除或重构，因此，确保代码易于阅读和理解非常重要，这样开发人员就可以使用它而无需询问您。

在设置代码样式时应考虑以下几点：

• 我的变量名有意义吗？
• 是否有注释来解释复杂功能？
• 您的代码中是否包含带有过多分支的长方法，可以将其重组为更简单的方法？
• 您是否遵守团队的空格/制表符选择，对空白的使用是否有意义？

安全

安全性应始终是软件开发过程的核心。 当您处理个人信息或使用任何第三方库或实用程序时，这种考虑变得尤为重要。 当用户共享诸如密码之类的敏感信息时，应始终对其进行加密，并遵守任何有效的验证方法。 此外，所有API密钥，会话令牌和授权功能都应以安全的方式实现。 如果您使用的是OAuth，请确保遵循字母的标准。

测试中

随着代码库的扩展，测试（尤其是负载和性能方面的测试）对于确保部署到生产中的所有代码都可操作且尽可能高效变得越来越重要。 您的所有代码都应具有随附的测试功能，以确保代码的稳定性。 您应该考虑检查总体连续集成测试，并确保它们通过所有检查。 花一些时间评估是否需要检查您的测试工具，并确保它们实际上在测试整个代码库。 此外，您的单元测试是否针对它们要归因于的特定功能，并且已经建立了涵盖所有潜在用例的测试框架？

修订的重要性

您团队的代码样式将随着时间的流逝而变化，因此您的代码检查清单也应随时间变化。 重要的是，随着代码的发展以及您变得越来越有经验，请继续更改清单，以确保清单覆盖了代码的每个领域。 如果您实施了新的换棉程序或测试过程，则您的代码检查清单应反映这些更改。

但是，计划和开发自己的代码审查过程可能会非常耗时。 您的时间很宝贵，通过外包代码审查需求，您可以花费更少的时间来担心代码的质量，而将更多的时间花在编写代码和交付产品上，这将使您的整个团队和公司受益！

Open Commit是一个“代码审查即服务”网络，可让您将代码审查外包给专家。 我们将与专业的软件开发人员配对，他们将对您的代码进行深入的审查，涵盖本文中列出的所有内容以及更多内容。 我们还允许您在工具内与我们的专家审阅者讨论代码，以便您对审阅有更深刻的了解，并对将来可以实施的最佳实践有更多的见解。

我们希望此清单为您提供了有关代码审查过程的一些清晰信息，但还远远不够全面。 我们的最后一个提示是记住要不断调整代码检查清单以满足您的需求。 编码愉快！

From: https://hackernoon.com/writing-an-amazing-code-review-checklist-de65479e8524