如何 review 别人的代码

代码审查（Code Review）是软件开发过程中的一项重要实践，旨在通过批判性地检查和改进代码来提高软件质量、促进团队合作、并互相学习。有效的代码审查技巧包括明确审查目标、细心审查、提出建设性的反馈、与编写者沟通、考虑代码的上下文环境和未来的可维护性，同时，一个好的审查者应该具备细心观察、深入理解代码的能力，并始终以提高整个项目质量为目标。

一、设立合理的代码审查标准

在开始审查他人的代码之前，首要任务是确立一套统一的代码审查标准。这些标准不但要涵盖代码的功能性、性能、安全性，还要包括代码风格、一致性和文档的完整性。团队内部的成员需要对这些标准达成共识，并守住这个质量关卡。

设定标准的目的

设立代码审查标准的目的在于确保所有团队成员都有一个明确的指导方针可循。标准可以减少由于个人编码习惯不同带来的摩擦，并帮助审查者迅速识别出改进的方向。

如何制定标准

制定标准时候，可以从业界公认的最佳实践入手，并结合团队的具体情况来调整。代码审查工具和自动化检查程序可以帮助团队成员坚持这些标准。

二、通读代码，理解逻辑

审查代码不仅是简单地找错误，更重要的是要理解代码所要解决的问题以及实现问题解决的逻辑。一个高效的审查者会尝试在脑海中运行这段代码，如果可能，还应该下载代码在本地环境下运行，确保理解了代码的全貌。

理解作者的意图

理解代码编写者的意图是有效审查的关键。审查者需要形成对问题和解决方法的全面认识，这样才能在审查中做出恰当的判断和提议。

关注代码的结构和模块化

良好的代码结构和模块化可以使逻辑更清晰、更容易理解。审查代码时，要关注代码的组织方式，识别模块化是否合理，以及功能是否适当分解。

三、评估代码质量

在代码审查的过程中，应当评估代码质量，包括检查代码是否简洁、是否遵循编程原则如DRY（Don't Repeat Yourself）和KISS（Keep It Simple, Stupid），以及是否存在潜在的性能问题。

检查代码简洁性

代码的简洁性直接影响可读性和可维护性。审查时要注意代码中是否含有多余的复杂结构，以及是否可以进一步简化。

确认编程原则是否得到遵循

高质量的代码往往遵循一系列编程原则和模式。审查时要检查这些原则是否得到了实际应用，从而保证代码的健壮性和可维护性。

四、考虑代码的可读性和一致性

代码的可读性和一致性对于团队合作至关重要。这包括代码风格、命名约定、注释的质量等方面。统一的代码风格与命名规则有助于保持代码库整洁有序。

提升代码的可读性

将注意力放在代码的可读性上，检查变量命名是否合理、注释是否清晰，并考虑代码布局和格式是否规整。

保持代码风格一致

风格的一致性有助于团队成员更快地理解和修改代码。应使用工具如代码格式化程序来保证风格的统一。

五、注重反馈的建设性

提供审查意见时应注意措辞，确保反馈是具有建设性的。直截了当的批评可能会伤害到代码作者的自尊心，而建设性的反馈可以以更积极的方式促进改进。

提供具体而明确的改进建议

给出的反馈应该是具体和明确的，以便作者能够清楚地知道如何改进代码。

避免人身攻击，关注代码

讨论问题时要保持专业和客观，集中讨论代码本身，避免对个人的任何评论或攻击。

六、促进代码的可维护性和可扩展性

良好的代码不仅要在当前工作正常，同样重要的是能够容易地维护和扩展。代码审查应当评估代码的长期可行性，包括架构的选择、代码的复用性、以及是否考虑了未来可能的变化。

促进代码的长期健康

检查代码是否适应长期发展，例如是否过于依赖当前环境下的特定实现，以及是否易于在不影响现有功能的情况下进行扩展或修改。

推动技术债务的减少

技术债务是开发过程中累积的，可能会影响未来开发效率的问题。代码审查应识别并建议改善或解决这些问题。

七、测试和验证

在代码审查过程中应确保嵌入了充分的测试，包括单元测试、集成测试和端到端测试等。这有助于验证代码的功能是否满足预期，以及是否对现有功能造成影响。

确保代码经过了充分测试

评估代码是否有配套的测试覆盖，并检视这些测试的质量和完整性。

鼓励TDD（测试驱动开发）实践

鼓励和指导开发人员采用TDD实践，这可以在编写代码的过程中确保质量控制，并容易发现潜在的逻辑或设计问题。

八、沟通和协作

代码审查不是单向的批评过程。它应该是一个协作和沟通的过程，旨在通过互相学习和共同努力提高代码质量。

促进积极的沟通

在审查过程中，应当鼓励开放而诚实的沟通，以便更好地交流思路和解决方案。

制定明确的审查流程

为确保审查的效率和质量，应当建立一套清晰的代码审查流程，并确保所有成员都遵守。

通过上述步骤，不仅可以在代码审查过程中提高个人技能，还能促进团队成员间的互动和知识共享，从而最终提升整个开发团队的工作效率和产品的质量。

相关问答FAQs：

Q: 我应该如何评审他人的代码？

A: 评审他人的代码是一个重要的任务，这里有几个关键步骤：

1. 审视代码结构和可读性： 首先，检查代码的结构和组织是否清晰。了解代码的逻辑流程，确保代码易于阅读和理解。
2. 查找潜在的问题： 然后，仔细检查代码中可能存在的逻辑错误、潜在的性能问题、可能的安全漏洞等。确保代码能够在各种情况下正常运行。
3. 评价命名规范和注释： 查看代码中的变量、函数和类等的命名规范是否一致和易于理解。同时，检查是否存在必要的注释，以便其他人能够理解代码的作用和目的。
4. 提供有建设性的反馈： 评审过程中，给出尽可能具体的反馈。指出潜在的问题，并提供改进的建议。确保反馈能够帮助开发者更好地改进他们的代码。

Q: 如何有效地评价他人的代码质量？

A: 评价他人的代码质量需要一定的技巧和方法，以下是一些有效的评价方法：

1. 使用代码规范进行比较： 将代码与所遵循的代码规范进行对比，检查是否存在与规范相违背的地方。这样可以帮助你更好地评估代码的质量和一致性。
2. 注重代码的可维护性： 评估代码是否易于维护和修改。看看代码是否容易理解、扩展和重用。同时，检查是否存在重复代码，并提供优化建议。
3. 关注安全和性能问题： 仔细检查代码中是否存在潜在的安全漏洞和性能问题。提供相应的修复建议，确保代码能够在各种情况下运行安全高效。
4. 认真审查文档和注释： 检查代码是否有详细和准确的文档和注释。这不仅有助于理解代码，还是其他开发者维护代码时的重要参考资料。

Q: 如何在评审他人的代码时保持客观和尊重？

A: 在评审他人的代码时，保持客观和尊重是非常重要的。以下是几个建议：

1. 专注于代码本身： 将注意力集中在代码质量上，而不是个人。不要批评作者，而是集中在提供有意义的建议和改进方向上。
2. 使用事实和数据来支持意见： 在提供评论时，使用事实、数据和具体的例子来支持自己的意见。避免主观性的评价，而是通过具体问题和解决方案来让人们理解你的观点。
3. 采用积极的语言： 使用积极的语言来表达自己的想法。尽量使用鼓励和支持的语气，让他人感到你是帮助他们的，而不是批评他们。
4. 提供明确的改进建议： 给出具体而明确的建议，帮助他人改进他们的代码。提供具体的代码段示例，以更好地说明你的观点和建议。

最后建议，企业在引入信息化系统初期，切记要合理有效地运用好工具，这样一来不仅可以让公司业务高效地运行，还能最大程度保证团队目标的达成。同时还能大幅缩短系统开发和部署的时间成本。特别是有特定需求功能需要定制化的企业，可以采用我们公司自研的企业级低代码平台：织信Informat。 织信平台基于数据模型优先的设计理念，提供大量标准化的组件，内置AI助手、组件设计器、自动化（图形化编程）、脚本、工作流引擎（BPMN2.0）、自定义API、表单设计器、权限、仪表盘等功能，能帮助企业构建高度复杂核心的数字化系统。如ERP、MES、CRM、PLM、SCM、WMS、项目管理、流程管理等多个应用场景，全面助力企业落地国产化/信息化/数字化转型战略目标。