Google是一个非常优秀的公司。他们做出了很多令人称赞的东西—既是公司外部,人们可以看到的东西,也是公司内部。有一些在公司内部并不属于保密的事情,在外部并没有给予足够广泛的讨论。这就是我今天要说的。
让Google的程序如此优秀的一个最重要的事情看起来是非常的简单:代码审查。并不是只有Google做这个事情—代码审查已经被广泛的认可为一种非常好的做法,很多人都在这样做。但我还没有看到第二家这样大的公司能把这种事情运用的如此普遍。在Google,没有程序,任何产品、任何项目的程序代码,可以在没有经过有效的代码审查前提交到代码库里的。
所有人都要经过代码审查。并且很正规的:这种事情应该成为任何重要的软件开发工作中一个基本制度。并不单指产品程序——所有东西。它不需要很多的工作,但它的效果是巨大的。
从代码审查里能得到什么?
很显然:在代码提交前,用第二群眼睛检查一遍,防止bug混入。这是对其最常见的理解,是对代码审查的好处的最广泛的认识。但是,依我的经验来看,这反倒是它最不重要的一点。人们确实在代码审查中找到了bug。可是,这些在代码审查中能发现的绝大部分bug,很显然,都是微不足道的bug,程序的作者花几分钟的时间就能发现它们。真正需要花时间去发现的bug不是在代码审查里能找到的。
代码审查的最大的功用是纯社会性的。如果你在编程,而且知道将会有同事检查你的代码,你编程态度就完全不一样了。你写出的代码将更加整洁,有更好的注释,更好的程序结构——因为你知道,那个你很在意的人将会查看你的程序。没有代码审查,你知道人们最终还是会看你的程序。但这种事情不是立即发生的事,它不会给你带来同等的紧迫感,它不会给你相同的个人评判的那种感受。
还有一个非常重要的好处。代码审查能传播知识。在很多的开发团队里,经常每一个人负责一个核心模块,每个人都只关注他自己的那个模块。除非是同事的模块影响了自己的程序,他们从不相互交流。这种情况的后果是,每个模块只有一个人熟悉里面的代码。如果这个人休假或——但愿不是——辞职了,其他人则束手无策。通过代码审查,至少会有两个人熟悉这些程序——作者,以及审查者。审查者并不能像程序的作者一样对程序十分了解——但他会熟悉程序的设计和架构,这是极其重要的。
当然,没有什么事情能简单的做下来的。依我的经验,在你能正确的进行代码审查前,你需要花时间锻炼学习。我发现人们在代码审查时经常会犯一些错误,导致不少麻烦——尤其在一些缺乏经验的审查者中经常的出现,他们给了人们一个很遭的代码审查的体验,成为了人们接受代码审查制度的一个障碍。
最重要的一个原则:代码审查用意是在代码提交前找到其中的问题——你要发现是它的正确。在代码审查中最常犯的错误——几乎每个新手都会犯的错误——是,审查者根据自己的编程习惯来评判别人的代码。
对于一个问题,通常我们能找出十几种方法去解决。对于一种解决方案,我们能有百万种编码方案来实现它。作为一个审查者,你的任务不是来确保被审查的代码都采用的是你的编码风格——因为它不可能跟你写的一样。作为一段代码的审查者的任务是确保由作者自己写出的代码是正确的。一旦这个原则被打破,你最终将会倍感折磨,深受挫折——这可不是我们想要的结果。
问题在于,这种错误是如此的普遍而易犯。如果你是个程序员,当你遇到一个问题,你能想到一种解决方案——你就把你想到的方案作为标准答案。但事情不是这样的——作为一个好的审查者,你需要明白这个道理。
代码审查的第二个易犯的毛病是,人们觉得有压力,感觉非要说点什么才好。你知道作者用了大量的时间和精力来实现这些程序——不该说点什么吗?
不,你不需要。
只说一句“哇,不错呀”,任何时候都不会不合适。如果你总是力图找出一点什么东西来批评,你这样做的结果只会损害自己的威望。当你不厌其烦的找出一些东西来,只是为了说些什么,被审查人就会知道,你说这些话只是为了填补寂静。你的评论将不再被人重视。
第三是速度。你不能匆匆忙忙的进行一次代码审查——但你也要能迅速的完成。你的同伴在等你。如果你和你的同事并不想花太多时间进行代码复查,你们很快的完成,那被审查者会觉得很沮丧,这种代码审查带来的只有失望的感觉。就好象是打搅了大家,使大家放下手头的工作来进行审查。事情不该是这样。你并不需要推掉手头上的任何事情来做代码审查。但如果中途耽误了几个小时,你中间还要休息一会,喝杯茶,冲个澡,或谈会儿闲话。当你回到审查现场,你可以继续下去,把事情做完。如果你真是这样,我想没有人愿意在那干等着你。
原文出处: Mark CC
译文出处:外刊IT评论
相关推荐
Java代码审查工具是提高软件质量和团队协作效率的重要手段。代码评审是一种系统性的源代码检查过程,旨在确保代码符合编程标准,减少错误,提高可维护性和可读性,同时也能促进团队成员之间的知识共享。在这个过程中...
谷歌的代码审查.txt
包括像Google、微软这些公司,CodeReview都是基本要求,代 我一直认为CodeReview(代码审查)是软件开发中的最佳实践之一,可以有效提高整体代码质量,及时发现代码中可能存在的问题。包括像Google、微软这些公司,...
### ASP 代码审查工具知识点详解 #### 一、代码审查概览 代码审查(Code Review)作为软件开发过程中至关重要的一个环节,旨在提高代码质量、减少缺陷并促进团队协作。通常,这一过程涉及代码创作者与审查人员之间...
Gerrit代码审查工具是一个基于Git项目的代码审查和项目管理工具。 Gerrit允许任何授权用户向主Git存储库提交更改,从而简化了基于Git的项目维护,而不是要求所有已批准的更改由项目维护者手动合并。 Gerrit利用网页...
在上一篇文章中提到过,我已经不在Google工作了。我还没有想清楚应该去哪里—有两三个非常好的工作机会摆在我面前。因为在这段做决定时间里,我不再受雇于任何人,我想可以写一些专业性的东西,一些很有趣,但也会在...
Gerrit代码审查工具是一款基于Web的开源代码审查系统,主要设计用于Git版本控制系统。它提供了方便、高效的代码审查流程,使得开发团队可以更有效地协作,确保代码质量。Gerrit v3.0.12是该工具的一个稳定版本,包含...
Gerrit是一个基于Git项目的代码审查和项目管理工具。 Gerrit允许任何授权用户向主Git存储库提交更改,从而简化了基于Git的项目维护,而不是要求所有已批准的更改由项目维护者手动合并。 Gerrit利用网页浏览器,使...
### 什么是代码审查? 代码审查是一种软件工程实践,其中一名开发者编写代码后,由另一名开发者进行审查。这种审查通常涉及对代码的逐行细致检查,旨在非威胁性的环境下促进合作而非寻找错误。代码审查是编码过程的...
Google的工程实践文档 ...[Google的代码审核指南 (Google’s Code Review Guidelines)],它包含两部分: - 代码审核者指南 (The Code Reviewer’s Guide) - 代码提交者指南 (The Change Author’s Guide)
提高C/C++代码质量的三种关键工具和方法:静态分析、代码审查与单元测试。首先,静态分析通过解析源代码,在不运行程序的情况下检测潜在的错误、规范违例和性能问题,推荐使用Clang-Tidy、Cppcheck等工具,并强调将...
**谷歌代码规范检查工具——cpplint** 谷歌是一家在软件开发领域有着极高影响力的公司,它不仅贡献了众多开源项目,还制定了严格的编程规范,以确保代码的可读性、可维护性和团队协作效率。其中,`cpplint.py`是...
当你导入这个模板到Eclipse中,你可以确保你的代码在保存时自动按照Google的推荐风格进行格式化,从而保持团队代码的一致性,提高代码审查效率。 首先,模板会设置默认的缩进方式为使用空格而不是制表符,通常设定...
本篇是谷歌是如何做代码审查的的续篇。我们在谷歌所做事情中另外一个让我感到异常有效、有用的制度是严格的编码规范。在到Google工作之前,我一直认为编码规范没有什么用处。我坚信这些规范都是官僚制度下产生的浪 ...
在实际工作中,遵循统一的编码风格能够减少代码审查的时间,提高开发效率,并有助于建立高质量的软件产品。对于想要进入谷歌或类似重视代码风格的公司工作的程序员来说,熟悉和掌握这套风格指南至关重要。
谷歌风格指南提倡同行评审,确保代码符合项目规范,并鼓励开发者积极参与他人的代码审查,促进知识共享和团队协作。 **6. 项目管理** 在项目管理方面,谷歌推荐使用GitHub或类似的平台进行项目托管,利用问题跟踪...
2. Google的代码审查指南:Google 公布的一套全面的代码审查指南,涵盖了从开始到结束的整个审查过程。 3. Coursera 和 edX 上的课程:这些在线教育平台提供了专门的课程,教授如何进行高效代码审查。 五、Code...
为您提供Gerrit代码审查工具下载,Gerrit是一个基于Git项目的代码审查和项目管理工具。Gerrit允许任何授权用户向主Git存储库提交更改,从而简化了基于Git的项目维护,而不是要求所有已批准的更改由项目维护者手动...
文档开头提到了谷歌的软件开发流程,包括源代码仓库、构建系统、代码审查、测试、缺陷跟踪、编程语言选择、调试与性能分析工具、发布工程、发布审批和事后分析等关键步骤。每一个环节都是软件工程质量的保障,也是...