什么是代码审查？
代码审查是确保错误和错误在进入生产环境之前被捕获和修复的过程。这通常需要开发人员的参与，他们没有直接参与实施正在审查的代码的特定部分。代码审查是更大的质量保证过程的一部分，以确保最终产品完全符合预期。
除了检查源代码的错误之外，代码审查是检查代码库中是否存在最佳实践和[反模式的好方法]
为什么代码审查很重要？
人们经常对各种各样的事情有不同的看法，尤其是在代码方面，这完全可以！但是，当涉及到生产应用程序中使用的代码库时，您需要确保团队中的所有开发人员在命名策略或架构模式方面使用相同的语言。
为什么这很重要？想象一下，A 和 B两个开发人员一起编写应用程序。A 喜欢使用全局单例字符串（也称为[Singleton 模式] ）进行状态管理，而 B 更喜欢使用[State 模式] 。他们在应用程序的不同部分工作，将他们的更改直接提交到共享存储库。
然后爱丽丝休假几周离开项目，现在鲍勃必须修复她实现的功能中的错误。他看到全局单例字符串，困惑地将其更改为状态模式实现，就像他之前实现的所有功能一样。
不幸的是，这样做需要两倍的时间来修复错误，因此 B 很快变得恼火和失望。
如果他们从一开始就实施代码审查流程，A 和 B就会更快地识别出风格上的差异。他们需要的是一个对双方都有意义的协作工作流程。
**代码审查应该涵盖哪些内容？ **
让我们来看看成功的代码审查应该涵盖哪些内容以及审查者应该密切关注代码的哪些元素的基本轮廓。
在执行代码审查时，审查代码的人应该关注以下几点：
- 代码风格
- 可读性
- 图案
- 建筑学
无代码审查的影响
为什么代码审查如此重要？如果没有代码审查或代码审查过多会发生什么？
**1. 可能引入高风险错误。 **
代码审查主要用于查找代码中的错误。如果代码审查太少，或者根本没有代码审查，一些错误很可能会在不被注意的情况下传递到生产中。错误可能会导致低风险（例如错误的 UI）或高风险（例如安全漏洞）。如果没有代码审查，团队几乎没有工具来预测和评估此类风险。
**2. 不一致的代码库。 **
就像 A和 B 的例子一样，人们倾向于喜欢不同的模式和代码风格，并且可能使用不同的方法来管理状态。方法的差异可能会减慢进一步的开发和代码支持。每次你需要实现新的东西或修复一个错误时，开发人员都必须花时间和精力去学习一个新的过程，从而进一步减慢这个过程。
3. 总线因素。
[总线因素] 是指与团队成员之间不共享信息和能力相关的风险度量。
因此，如果只有一个人知道项目的特定部分是如何工作的——编写它的人——并且该人离开了项目，你可能需要执行另一次代码审查，甚至一起重写代码。
太多的代码审查
当涉及到过多的代码审查时，相关的风险很少，但也有一些缺点，可以这么说。进行大量代码审查会导致生产延迟，并可能导致开发人员过分关注满足代码审查，而不是实现高级业务目标。
归根结底，找到黄金中位数很重要。如果您必须优先考虑更快的代码生产，请评估与限制代码审查相关的风险。
代码审查清单
代码审查首先是一个沟通过程。和其他任何人一样，参与其中的每个人都应该感到受到尊重，因为这个过程是高效的。因此，要遵循一些简单的规则，使您的代码审查有用且美观，同时还提供有用的反馈。
如果您是执行审查的人，请考虑以下代码审查清单：
**1. 解释你的意见。 **
在指出错误时，添加一些解释，说明为什么您认为这应该被视为错误。这会让你听起来很自信，也会帮助代码的作者在未来不再犯类似的错误。
另一方面，可能是你错了。解释您来自哪里将有助于鼓励讨论以在意见有任何差异时找到最佳解决方案。
2. 包括示例。
有时，很难理解诸如“根据指南进行更改”或“使用 X 模式”之类的消息。对你来说可能很明显的事情对其他人来说可能是一个完整的谜语。
给出一个简短的例子，说明你认为最终结果应该是什么样子，以帮助作者理解你的想法。
3. 指出具体问题。
“我不知道这段代码有什么问题，但你可以做得更好”并不是很有帮助。确切地告诉代码的作者是什么导致了问题。是内存管理吗？是代码风格吗？
确保提供有用的详细信息，尤其是在解决方案需要作者进一步调查的情况下。大多数时候，当代码没有以令人满意的状态提供时，更好的解决方案不会突然出现在审阅者的脑海中。要求作者进一步调查是可以的，但你应该提供一些方向。
代码审查技巧
人们在合作时工作效率更高。“两个头比一个头好，”对吧？这正是为什么，作为审稿人，您应该尝试听起来友好的原因。保持合作的语气有助于团队专注于解决手头的问题，而不是升级冲突。
以下是一些关于语气的代码审查技巧：
- 避免责备。
- 不要说：“你做了坏事”；说：“这样做不好，这就是为什么……” 毕竟，谁编写了错误的代码并不重要。重要的是这段代码是否得到修复。所以专注于评论代码而不是开发人员。
- 代码审查不是性能评估。
- 简单地告诉某人他们不够好并不能帮助他们变得更好。将代码审查视为异步结对编程过程的一部分。你不会告诉你的结对编程伙伴他们在编码方面很烂，是吗？相反，你帮助他们纠正错误。这种方法也适用于代码审查。
- 要有同理心。
- 代码审查评论充满批评可能会让人不知所措，即使批评写得尽可能友好。当你看到好的代码时，表现出一些同理心和赞美！它可以走很长的路。当开发人员花费时间和精力为团队和产品做一些有价值的事情时，值得注意的是！
- 对进一步讨论持开放态度。
- 每个代码审查评论都应该是可讨论的。您可以主动联系参与该流程的任何人以详细说明此事或确保您的团队知道如何与您联系。一个及时的电话甚至几条消息都可以节省大量时间、减少误解和痛苦。
谁应该进行代码审查？
代码审查过程中的主要问题之一是谁应该进行审查？基本上，有两种选择：
- 一名指定人员（通常是高级开发人员或团队负责人）为团队中的每个人执行代码审查。
- 团队中的每个人都可以进行代码审查。
网友评论