Reading 4: Code Review
本文内容来自MIT 6.031,源地址为http://web.mit.edu/6.031/www/sp18/classes/04-code-review/
今日目标
在今天的课程中,我们将会练习:
- code review(代码评审):阅读并讨论由他人所写的代码
- general principles of good coding(良好代码的一般原则):你可以在每次代码评审中找到的东西,与编程语言或程序目的无关
Code Review(代码评审)
代码评审是一件系统性,谨慎的,由非代码原作者对源代码进行的研究过程。它类似于评审学术论文。
代码评审实际上有两个目的:
- Improving the code(改进代码)。找到bug,预测可能的bug,检查代码的清晰度,并且检查是否与项目的风格标准相一致。
- Improving the programmer(提高程序员)。代码评审是一种程序员互相讨教提升的重要方法。他们互相之间可以学习新的语言特性,项目中设计变化或项目的代码标准,或者新的技术。在开源项目中,特别的,很多对话发生在代码评审的上下文中。
代码评审在开源项目(例如Apache和Mozilla)中得到广泛实践。代码评审在工业中也得到广泛应用。在Google,在没有其他工程师在评审中签字时,你不能将任何代码推送到主仓库中。
在6.031中,我们将在问题集中应用代码评审,就像 Code Reviewing document 中所描述的一样。