关于代码Review

在一个项目组里面,经常会互相review同事的代码,review的过程中相信会产生不少矛盾,这篇文章记录一下我对代码review的一些看法。首先是编码规范的问题,拿PHP来说。比如命名规范,indent之类的。这些都应该在项目编码开始之前大家立好规矩。是采用驼峰命名法还是用下划线分割单词,indent�是用tab还是用空格,大括号是换行:

function foo() {
}

还是不换行:

function foo() 
{
}

这些最基础格式规范一定要在最开始写在一个wiki文档上,项目组所有成员都需要熟记这个规范。这种规范,两上个技术骨干定一下就好了,定下来就按它执行。这个东西其实只要统一就好,无需纠结,孰好孰坏也并不影响项目质量。

接下来我说一下我对关于一些实现逻辑的写法review的个人理解,比较经典的是关于 if...else...�的用法的讨论。如果一个函数中用if...else来做分支处理,代码如下:

if($flag = 1)
{
    .....
    $result = 'A';
}else if($flag = 2) {
    .....
    .....
    $result = 'B';
}else {
    .....
    .....
    $result = 'C';
}

.....
.....
return $result;

这种情况,如果if...else语句下面的处理跟逻辑跟结果A或者B没有什么关系的话 ,可以改写成如下代码,使得代码逻辑更加清晰

if($flag = 1)
{
    .....
    return 'A';
}
if($flag = 2) {
    .....
    .....
    return 'B';
}
.....
.....

.....
.....
return 'C';

简单一句话就是,适当的去掉if...else而换成if return结构,很多时候可以提高程序的可读性,但也不能认准这个死道理,比如下面这段(形式A)代码

    function foo($flag) {
        if($flag) {
            $var = 'A';
        }else {
            $var = 'B';
        }

        ....
    }

我的同事review的时候建议改成如下(形式B):

    function foo($flag) {
        $var = 'B';
        if($flag) {
            $var = 'A';
        }
        ....
    }

这其实并没有意义,首先这并没有增加程序的可读性,其次形式A的代码其实更符合人类的思维,它表述出$var变量非A既B的逻辑,而下面的代码表述的是$var变量的默认值是A,当flag为true的时候它被赋值B,给人一种它可能还会有其他情况被赋值为C、D ... 之类的值的预期。

所以在review代码的时候不能教条(简单的认为只要去掉else代码就会变得更简单易读),review需要关注的点应该是是否有逻辑漏洞,潜在BUG,非常小可能性出现的异常没有处理。而对于代码的表述方式,不应该过多关注。所以反之若是有人写了形式B的代码,也没有必要在review的时候,让他改成形式A。如果review的这么仔细,不但不会提高代码质量,反而会大大减慢项目的开发进度,增加沟通成本。

所以,review这件事,要有度!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,293评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,604评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,958评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,729评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,719评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,630评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,000评论 3 397
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,665评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,909评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,646评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,726评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,400评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,986评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,959评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,996评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,481评论 2 342

推荐阅读更多精彩内容