资讯频道 → 研发管理
阅读更多

4顶
0踩

研发管理

转载新闻 高效代码审查的十个经验

2012-11-09 17:21 by 副主编 MnouW 评论(1) 有5671人浏览
代码审查 编程
代码审查（Code Review)是软件开发中常用的手段，和QA测试相比，它更容易发现和架构以及时序相关等较难发现的问题，还可以帮助团队成员提高编程技能，统一编程风格等。

1.  代码审查要求团队有良好的文化

团队需要认识到代码审查是为了提高整个团队的能力，而不是针对个体设置的检查“关卡”。

“A的代码有个bug被B发现，所以A能力不行，B能力更好”，这一类的陷阱很容易被扩散从而影响团队内部的协作，因此需要避免。

另外，代码审查本身可以提高开发者的能力，让其从自身犯过的错误中学习，从他人的思路中学习。如果开发者对这个流程有抵触或者反感，这个目的就达不到。

2.  谨慎的使用审查中问题的发现率作为考评标准



在代码审查中如果发现问题，对于问题的发现者来说这是好事，应该予以鼓励。但对于被发现者，我们不主张使用这个方式予以惩罚。软件开发中bug在所难免，过度苛求本身有悖常理。更糟的是，如果造成参与者怕承担责任，不愿意在审查中指出问题，代码审查就没有任何的价值和意义。

3.  控制每次审查的代码数量

根据smartbear在思科所作的调查，每次审查200行-400行的代码效果最好。每次试图审查的代码过多，发现问题的能力就会下降，具体的比例关系如下图所示：



我们在实践中发现，随着开发平台和开发语言的不同，最优的代码审查量有所不同。但是限制每次审查的数量确实非常必要，因为这个过程是高强度的脑力密集型活动。时间一长，代码在审查者眼里只是字母，无任何逻辑联系，自然不会有太多的产出。

4.  带着问题去进行审查

我们在每次代码审查中，要求审查者利用自身的经验先思考可能会碰到的问题，然后通过审查工作验证这些问题是否已经解决。一个窍门是，从用户可见的功能出发，假设一个比较复杂的使用场景，在代码阅读中验证这个使用场景是否能够正确工作。

使用这个技巧，可以让审查者有代入感，真正的沉浸入代码中，提高效率。大家都知道看武侠小说不容易瞌睡，而看专业书容易瞌睡，原因就是武侠小说更容易产生代入感。

有的研究建议每次树立目标，控制单位时间内审核的代码数量。这个方法在我们的实践中显得很机械和流程化，不如上面的方法效果好。

5.  所有的问题和修改，必须由原作者进行确认

如果在审查中发现问题，务必由原作者进行确认。

这样做有两个目的：

  • 确认问题确实存在，保证问题被解决
  • 让原作者了解问题和不足，帮助其成长
有些时候为了追求效率，有经验的审查者更倾向于直接修改代码乃至重构所有代码，但这样不利于提高团队效率，并且会增加因为重构引入新bug的几率，通常情况下我们不予鼓励。

6.  利用代码审查激活个体“能动性”

即使项目进度比较紧张，无法完全的进行代码审查，至少也要进行部分代码的审查，此时随即抽取一些关键部分是个不错的办法。

背后的逻辑是，软件开发是非常有创造性的工作，开发者都有强烈的自我驱动性和自我实现的要求。让开发者知道他写的任何代码都可能被其他人阅读和审察，可以促使开发者集中注意力，尤其是避免将质量糟糕，乃至有低级错误的代码提交给同伴审查。开源软件也很好的利用了这种心态来提高代码质量。

7.  在非正式，轻松的环境下进行代码审查

如前所述，代码审查是一个脑力密集型的工作。参与者需要在比较轻松的环境下进行该工作。因此，我们认为像某些实践中建议的那样，以会议的形式进行代码审查效果并不好，不仅因为长时间的会议容易让效率低下，更因为会议上可能出现的争议和思考不利于进行如此复杂的工作。

8.  提交代码前自我审查，添加对代码的说明

所有团队成员在提交代码给其他成员审查前，必须先进行一次审查。这次自我修正形式的审查除了检查代码的正确性以外，还可以完成如下的工作：

  • 对代码添加注释，说明本次修改背后的原因，方便其他人进行审查。
  • 修正编码风格，尤其是一些关键数据结构和方法的命名，提高代码的可读性。
  • 从全局审视设计，是否完整的考虑了所有情景。在实现之前做的设计如果存在考虑不周的情况，这个阶段可以很好的进行补救。
我们在实践中发现，即使只有原作者进行代码审查，仍然可以很好的提高代码质量。

9.  实现中记录笔记可以很好的提高问题发现率

成员在编码的时候应做随手记录，包括在代码中用注释的方式表示，或者记录简单的个人文档，这样做有几个好处：

  • 避免遗漏。在编码时将考虑到的任何问题都记录下来，在审查阶段再次检查这些问题都确认解决。
  • 根据研究，每个人都习惯犯一些重复性的错误。这类问题在编码是记录下来，可以在审查的时候用作检查的依据。
  • 在反复记录笔记并在审查中发现类似的问题后，该类问题出现率会显著下降
10.  使用好的工具进行轻量级的代码审查

“工欲善其事，必先利其器”。我们使用的是bitbucket提供的代码托管服务。

每个团队成员独立开发功能，然后利用Pull Request的形式将代码提交给审查者。复审者可以很方便在网页上阅读代码，添加评论等，然后原作者会自动收到邮件提醒，对审阅的意见进行讨论。

即使团队成员分布在天南海北，利用bitbucket提供的工具也能很好的进行代码审查。
  • 大小: 90.7 KB
  • 大小: 24.5 KB
来自: 月光博客
4
顶
0
踩
评论 共 1 条 请登录后发表评论
1 楼 joynn 2013-01-20 01:07
最近准备搞这个，却无从下手，还没有形成专业的流程

发表评论

您还没有登录,请您登录后再发表评论

相关推荐

  • jboss部署成为linux服务

    NULL 博文链接：https://liuliliujian.iteye.com/blog/733867

  • JBoss的简单配置

    一,安装JBOSS：安装JBOSS很简单。将jboss-4.0.4.GA.zip解压到一个目录(比如d:\ jboss-4.0.4.GA)下即可。 提示：保留原来的zip文件，以免在使用过程中出错，还可以恢复到正常状态。二，运行JBOSS:在JBOSS的home目录(即$JBOSS_HOME \bin)有一个run.bat文件和 一个run.sh文件，直接运行r...

  • IntelliJ IDEA 与 JBOSS集成

    JBOSS：Jboss7 IntelliJ IDEA ：14 集成Jboss与集成tomcat大同小异，但是要JBOSS支持热部署，需要做些修改： 1、添加全局JBOSS容器： 菜单FILE-SETTING，弹出系统设置窗口，找到application server菜单： 点击右边的添加容器图标，下拉选择JBOSS，如图： 配置好你的JBOSS安装目录，IDEA会自动识...

  • idea部署maven+javaweb项目到jboss

    小编习惯使用eclipse对jboss跑的项目部署,第一次使用idea进行jboss部署项目,遇到很多问题,做此文章以帮助更多人. 图中涂鸦的是项目名,对应上自己的项目名即可 1.导入项目,这一步不多说 2.配置项目: a>点击file-->Project-Stucture-->Project ...

  • 如何使用JBOSS在IDEA上启动Maven项目

    1.第一步 导入项目到你的IDEA中 正常导入项目选择对应JDK就可以了 2.选择启动环境JBOSS 导入工程所需jar包防止内存溢出导致程序蹦溃的配置: -Xms1024m -Xmx2048m -XX:PermSize=1024m -XX:MaxPermSize=2048m 点击Configure配置选择本地自己下载的jboos 将项目导成war包。到这一步就完成啦！可以 apply ok啦 后续只要导入项目工程中所需jar包基本就能运行环境啦 file->project structure -&

  • IDEA 部署非MAVEN的JBOSS项目

    导入项目略。。。配置工程(File--> Project Structure)设置Project这里需要设置JDK版本，注意第二栏的位置所选JDK版本保持一致，最后一栏就是java文件的输出目录添加lib很早以前的老工程了，所以全部是本地jar包，这里需要手动设置jar包路径，选择即可。设置ModulesModules配置主要包含以下三点：SourcespathsDependenciesSo...

  • Jboss安装

    安装JDK 1、解压jdk后配置环境变量 JAVA_HOME=/usr/java/jdk1.8/ JRE_HOME=/usr/java/jdk1.8/jre PATH=$PATH:$JAVA_HOME/bin:$JRE_HOME/bin CLASS_PATH=.:$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.jar:$JRE_HOMR/lib export JAVA_HOME JRE_HOME PATH CLASS_PATH 安装Jboss 注：JDK1.8与Jbo

  • jboss的安装以及配置

    Jboss应用服务器的安装以及配置： 第一步：下载jbossEAP7.2（兼容jdk8+）， 下载链接：https://developers.redhat.com/products/eap/download 第二步：解压后，默认端口号是8080，可在解压目录下：standalone->configuration->standalone.xml修改 第三步：配置相应的坏境变量 ①添加JBOSS_HOME环境变量，value为你解压下的路径 ②在Path环境变量后添加：%JBOSS.

  • jboss应用服务器软件,JBOSS的安装与配置

    JBOSS的安装与启动一.安装Step1：下载jboss，本文介绍的安装版本是jboss-4.2.3.GA-jdk6.zip，解压该文件(注意解压路径不要包含空格)Step2：设置环境变量JBOSS_HOME 二.启动服务运行JBoss目录下的bin\run.bat 访问url： http://localhost:8080/ 进入JBoss的欢迎界面 二.停止服务停止JBoss必须执行shutdo...

  • JBOSS的下载安装、环境变量配置以及部署

    最近学习java学习了一下JBOSS，这篇文章记录了一下自己安装jboss的过程。 JBoss是纯Java的EJB（企业JavaBean）服务器。 1. 下载安装 http://jbossas.jboss.org/downloads/ 我下载的是：JBoss AS7.1.1.Final            2. 解压安装包  D:\programsetup\jboss-as-

  • 小白教程-JBoss的下载以及安装、部署

    一、Jboss下载：    1、点击 http://jbossas.jboss.org/downloads/找到合适的版本下载；    我这里是用的 Jboss-as-7.1.1.Final 版本，算是比较新的一个版本。    二、Jboss安装：    1、首先将下好的Jboss解压到自己想要存放的位置；    2、配置环境变量（非必要步骤），建议还是将环境变量配好，便于dos中命令操作；   ...

  • Linux下Jboss安装使用+Jboss部署脚本

    Jboss是Java EE应用服务器（就像Apache是web服务器一样），专门用来运行Java EE程序的。 JBoss的运行需要JAVA环境的支持，所以我们首先安装JDK。 本章环境： 系统：CentOS Linux release 7.9.2009 前期工作准备: 关闭防火墙 关闭selinux [root@server-jboos ~]# systemctl stop firewalld.service [root@server-jboos ~]# systemctl distable fir

  • IntelliJ IDEA和JBOSS配置及部署

    集成Jboss与集成tomcat大同小异，但是要JBOSS支持热部署，需要做些修改： 1、添加全局JBOSS容器： 菜单FILE-SETTING，弹出系统设置窗口，找到application server菜单： 选择安装好的jboss路径 2、应用JBOSS到项目： 弹出的框中点击添加图标，选择JBOSS - local，添加本地JBOSS（r

  • jboss怎么配置支持php,Linux_详细讲解安装配置Jboss的方法，1、 Jboss的配置安装　　　（1 - phpStudy...

    详细讲解安装配置Jboss的方法1、 Jboss的配置安装(1)、 Jboss的下载Jboss的下载地址为：http://www.jboss.org/.目前的最新版本是：Jboss2.2.1.建议你下载Jboss2.2.1和tomcat3.2.1集成的下载包，这样避免了单个下载后两者之间配置的问题。下载地址是：http://prdownloads.sourceforge.net/jboss/JBo...

  • idea2017 jboss7.1.1final初次部署web项目（图文）

    0x001环境 一个java web的项目 装好了的idea2017 已经按照好的本地jboss-as-7.1.1.Final客户端 起因因为最近看慕课网已经出了一起idea的使用教程课程，而之前一直想去接触这款新的开发工具，各种听说从不同方面对开发的效率会有很大的提升，于是下定决心去尝试一下，用公司的web项目正好搭建初次跑起来jboss的项目，以此来总结一下遇到的坑。0x002ready go

  • jboss热部署配置

    NULL 博文链接：https://lionelf.iteye.com/blog/1532452

  • 【EJB系列】（一）——JBOSS7中开发一个简单的EJB应用

    导读 　　在本篇文章中你将了解到如何使用JBOSS7开发出一个简单的EJB应用以及在这个过程中遇到的问题。 环境 MyEclipse10 JBOSS7 JDK1.8.0 准备MyEclipse10中配置JBOSS7了解JBOSS目录结果 首先了解一下JBOSS7的目录结构，和之前的版本不一样 在 JBoss 7 中，文件系统分为两部分： 1. 独立服务器stand

  • 如何用JBoss 运行相关的JSP程序

                                                     如何用JBoss 运行相关的JSP程序                                                                    作者：伊苏                                                     

Global site tag (gtag.js) - Google Analytics