文档章节

代码评审工作中需要注意的问题点

梨加橙
 梨加橙
发布于 2016/08/13 21:26
字数 2333
阅读 188
收藏 2

代码走查(code walkthrough)是一个开发人员与架构师集中讨论代码的过程。代码走查的目的是交换有关代码是如何书写的思路,并建立一个对代码的标准集体阐述。 在代码走查的过程中,开发人员都应该有机会向其他人来阐述他们的代码。 通常地,即便是简单的代码阐述也会帮助开发人员识别出错误并预想出对以前麻烦问题的新的解决办法。

当团队成员对代码进行讨论的时候,他们的讨论应该集中到一些重要的话题上,比如算法,基于对象的编程,类设计。 然而,许多代码走查不会做这些事,通常代码走查是枯燥的,烦人的,机械的。 这就是为什么许多开发人员讨厌这些。要使得代码走查变得很有效,那么这个过程就必须是有趣的,有创造性的。 很经常地,代码走查退化成了仅是关注于强制代码标准 —— 一个可以被自动执行的实践。当这种情形出现后,团队通常会觉得代码走查没有价值,然后将代码走查从他们开发过程中去除掉。这样便失去了他们可以从正确地执行代码走查的过程获益的机会。

为何要做代码走查?

代码可读性这个话题一直以来都是备受关注,但是可读性高与不高却没有统一的标准。毕竟各个公司,甚至于各个项目的规范都是不一样的。我们不能说一个抽象性极好,灵活度极高却让人十天半个月都难以搞清楚的代码的可读性高,也不能说一个长达几千行却从头至尾逻辑性比较好的代码的可读性差。那么怎样的代码才算是合理的,才算是可读性高的呢?我想不同之中必有共性,那就是经过走查的、能够被项目组其他成员接受并能尽快看懂的代码就是可读性好的。

要对代码可读性做走查,这需要人力、物力、以及项目宝贵的时间。对于一个项目来说,成本是一个重要的考虑因素,然而走查无疑会增加项目的成本,那么为什么还要做走查呢?其实任何一个项目经理都清楚一个成功的项目都是难以一蹴而就的,开发过程必然会遇到各种各样的问题和阻力,这也验证了那句老话:“软件开发中唯一不会变的就是,需求永远会变化”。我们也清楚问题越早的被发现那么损失就会越小,补救花费的时间就会越少,自然成本就越低。但是我们有多大的机会可以尽早的发现问题呢?这不是我们说早发现问题,问题就会跟我们招手说:“看你态度不错,就让你早发现吧!”这么简单的。迭代开发为什么会出现,瀑布式开发为什么难以应对大型的商业、行业项目?思考一下我们不难发现,客户难以一次性的、整体的、详尽的把自己想要的东西表达清楚,只有当客户看见实实在在的东西之后,他才更明确自己想要什么。好比我们去买裤子,你告诉一个人说:“我要一条简约的牛仔裤”;然后那个人去帮你买,但是具体的颜色你确定么,是黑色还是蓝色?衣服的口袋你确定么,是有扣子的还是没扣子的?只有当你真真切切的到专卖店里面,看到了试过了你才能确定:我要的就是那条180的蓝色的口袋上没扣子的XXX牌的裤子。也就是说我们很少能够尽早的从客户口中获得问题,除非我们指着我们做出来的东西说:看看,这是不是你想要的。既然如此,要控制的不是尽早的去发现问题,而是如何在问题出现之后尽早的找出问题所在,并解决问题,进而降低项目的成本。

其实软件开发的主要时间是花费在调试上,然而调试中花费的大部分时间又在于读代码。倘若之前开发该模块的人员已远在天边,面对几千行混乱无序的代码任谁都难以承受。因而花费成本在代码走查上是值得的,而且是必须的。可惜的是,现在很少有人去关注代码的规范性、可读性,甚至在大公司都是如此。项目管理者过于注重项目的进度,只要开发者把自己的任务做完了,很少有人去关注他写的代码,甚至开发者自己都不会再去看。

代码走查的好处

首先代码走查可以提高软件的质量,以及可维护性。这样就可以减少查找错误的时间,提高解决bug的效率,提高开发效率的同时降低后期的维护成本。

其次,经过走查的代码是能够迅速被项目组其他成员看懂的,这样有利于项目其他成员更全面的了解业务,对于成员之间交流也有很好的促进作用,当其中负责某个模块的开发人员离职之后其他人员能够迅速的接手相关的开发,并能够尽快的培养新人弥补空缺。

最后,代码走查的过程是总结提高的过程,也是交流的过程,可以有效的提高开发人员的技术水平以及业务素养,增强公司的竞争力,通过总结交流甚至可以从不同项目中提取共性,做出相关产品,从而形成公司自己的核心竞争力,做到行业领先。

如何去做代码走查?

从参加人员来说,应该是项目的整体参与者,如果项目太大,整体参加的成本很高,那么可以以模块为组进行走查。因为他们之间负责的业务是紧密相关的,使用的技术是接近程度比较大的,因而开发的规范应该是统一的。

从走查内容来说,应该是代码的命名规范,以及组织结构。每个项目都有自己的规范,但是如果项目内部使用不同的规范必然会增加发现问题、解决问题的难度,同时增加后期的维护成本。

从走查时间来说,应该在每个模块开发完成之后进行,便于开发人员之间交流问题以及体会,并且每个人的讲解时间不要超过30分钟,因为模块的业务复杂度不会那么复杂,30分钟都讲不清的业务逻辑如何保证代码是清晰的。

从走查的结果来说,经过走查的代码应该是参加成员大部分能认同的,并且参加者每个人都能读懂的逻辑清晰的代码,并且通过交流提高项目成员的凝聚力,提高其业务认知度,最好能形成项目之间可以共同使用的产品。

 

代码走查(code walkthrough)和代码审查(code inspection)是两种不同的代码评审方法,代码审查是一种正式的评审活动,而代码走查的讨论过程是非正式的。
最近项目组开会进行代码评审,发现可以对代码评审中找到的问题进行一下分类,大概可以分成以下几类问题:

1. Comment

注释没写,或者格式不对,或者毫无意义。在项目当中,注释可以大致分为如下几类:

属性注释

对外的方法,参数注释

类注释

Bug修改注释

重要逻辑,变量注释

未完成TODO注释,debug注释

SVN(或者其它的代码的版本控制系统)提交代码时,代码新版本修改内容的注释

2. Coding Standard

没遵守代码规范

1) 命名规范

2) 格式规范

3) 注释规范

4) 代码管理规范

5) 结构规范

6) 引用规范

7) 内部定义规范

8) 封装规范

3. Existing Wheel

重复现成的代码,或者是开源项目,或者公司已有代码

学会站在巨人的肩膀上

4. Better practice

Java或者开源项目,有更好的写法

对代码可以进行优化、重构

5. Performance bottle and Improvement

性能瓶颈和提高

示例:

6. Code Logic Error

代码逻辑错误

7. Business Logic Error

业务逻辑错误

代码审查列出问题的类型,并有解决情况报告。

© 著作权归作者所有

梨加橙
粉丝 35
博文 56
码字总数 43402
作品 0
南昌
后端工程师
私信 提问
Code Review是软件工程中很有意义的一个活动

Code reviews 确实有很多用处,而在实际工作中它被用来找到程序bug、保证代码风格、编码标准。过于负担了。它不应该承担发现代码错误的职责,而是审核代码的质量,如可读性,可维护性,健壮性...

liuran8354
2014/12/05
2.7K
13
聊聊面试时让候选人写代码

本文由伯乐在线 -清蒸竹马 翻译,艾凌风 校稿。未经许可,禁止转载! 英文出处:phil calcado。欢迎加入翻译组。 在 DigitalOcean,我们正在对后端开发人员招聘流程做出一些改变,简化了岗位...

伯乐在线
2017/01/08
0
0
十条精进原则,给迷茫于劳而无功的技术人

作者介绍 云鹏,2014年加入美团,先后参与了美团酒店供应链体系、分布式调度系统的建设,现在负责美团旅行客户关系管理系统、基础信息服务的建设工作。 时间回到8年前,我人生中的第一份实习...

云鹏
2018/10/29
0
0
敏捷落地的会议和工具

对于一个项目而言,不开会是不能很好达成共识的,统计一下会发现整个项目的会议确实开的不少,但真的有成效的有多少呢?不要为了开会而开会,开会要解决实际问题,开会不是大家无聊的瞎扯,每...

技术mix呢
2017/10/12
0
0
作为一名忙得要死的 DBA 人员,如何卸掉手上的一部分工作? - 知乎

我没有时间顾全一切 我是一名非常忙的 DBA。开发人员常常在不经过我 Review 代码的条件下,直接提交到生产环境。这导致我一次又一次地陷入被动的境地,在美好的周末里,开发人员可能都在海滩...

Python数据之道
10/21
0
0

没有更多内容

加载失败,请刷新页面

加载更多

PostgreSQL 11.3 locking

rudi
今天
5
0
Mybatis Plus sql注入器

一、继承AbstractMethod /** * @author beth * @data 2019-10-23 20:39 */public class DeleteAllMethod extends AbstractMethod { @Override public MappedStatement injectMap......

一个yuanbeth
今天
10
1
一次写shell脚本的经历记录——特殊字符惹的祸

本文首发于微信公众号“我的小碗汤”,扫码文末二维码即可关注,欢迎一起交流! redis在容器化的过程中,涉及到纵向扩pod实例cpu、内存以及redis实例的maxmemory值,statefulset管理的pod需要...

码农实战
今天
4
0
为什么阿里巴巴Java开发手册中不建议在循环体中使用+进行字符串拼接?

之前在阅读《阿里巴巴Java开发手册》时,发现有一条是关于循环体中字符串拼接的建议,具体内容如下: 那么我们首先来用例子来看看在循环体中用 + 或者用 StringBuilder 进行字符串拼接的效率...

武培轩
今天
8
0
队列-链式(c/c++实现)

队列是在线性表功能稍作修改形成的,在生活中排队是不能插队的吧,先排队先得到对待,慢来得排在最后面,这样来就形成了”先进先出“的队列。作用就是通过伟大的程序员来实现算法解决现实生活...

白客C
今天
81
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部