上QQ阅读APP看书,第一时间看更新
第2章 代码评审——过程及其重要性
代码评审活动的主要目的是提高代码的整体质量。代码质量的重要性是不言而喻的,当代码属于团队项目的一部分,或者可以被其他成员访问(例如开源开发者或客户通过某种托管协议访问该代码)时尤为如此。
如果每个开发人员都可以随心所欲地编写代码,那么你得到的将是以如此多不同方式编写的相同类型的代码,最终代码将变成一团乱麻。这就是为什么编码标准政策很重要,它规范了公司的编码实践和要遵循的代码评审流程。
在代码评审过程中,同行之间会互相评审代码。出错是人之常情,评审人将检查代码是否存在错误,是否违反了公司的编码准则,是否存在语法正确但可读性、可维护性和性能有待改进的代码。
本章涵盖如下主题:
- 准备代码评审
- 引导代码评审
- 确定评审内容
- 确定何时进行评审
- 提供代码评审反馈
请注意,我们将以开发者视角来讨论2.2节和2.5节;以代码评审者的视角讨论2.3节和2.4节;并分别以开发者视角和代码评审者视角讨论2.6节。
学习目标:
- 理解代码评审及其好处。
- 如何参与代码评审。
- 如何提供建设性的批评。
- 如何积极回应建设性的批评。
在我们深入这些主题之前,先来介绍一般的代码评审流程。