代码整洁之道 -- 更好地给函数命名

        在编程中,第一个学的是有意义的命名,那么第二个使用比较多的应该就是函数了,函数命名的好坏也对一个工程开发的效率起着很重要的作用。

一、函数的参数个数

        最理想的参数数量是0(零参数函数),其次是1(单参数函数),再次是2(双参数函数),应尽量避免3(三参数函数),有足够特殊的理由才能用3个以上的参数(多参数函数)。

        先说说单参数函数,比如一个函数这样调用:render(true),对于读者来说是不是有点懵逼,true?什么true?如果这个函数我只是想知道大概意思,写成这样就一定要点进去函数去查看了,是不是很麻烦?点进去看到函数的定义render(Boolean isSuite)我们才大概搞懂了这个函数参数的含义。如果把这个函数拆成renderForSuite()和renderForSingleTest(),就舒服很多了。

       再看看双参数函数,writeField(name)比writeField(outputStream, name),是不是writeField更加直接一点?带上outputStream的话,开发者还需要看这个stream是使用什么格式的,各种复杂的文档查询。另外就是在日常开发的时候,经常看到同事写类似断言的函数,比如Jest里面,写了一个isEquals(a, b),我不止一次遇到这样类似的函数,究竟第一个是期望值,还是实际值呢?每次都需要点进去函数去查看,十分的麻烦,如果在函数的命名上我们更人性化一些,这样的阅读就会更加舒服一些了,比如把它改成isExpectedEqualsToActual(a,b),读者无需查看详细的函数定义就知道这个函数参数的定义了。

二、 使用异常代替返回错误码

在多次条件判断的时候,如果异常判断比较复杂,比较容易出现一种情况,就是多重嵌套,多重嵌套处理起来是特别麻烦的一件事,比如:

if (deletePage(page) == 'success') {

    if (registry.deleteReference(page.name) == 'success') {

        if (keys.deleteKey(page.name.makeKey() == 'success') ) {

            logger.log("page deleted");

        } else {

            logger.log("key not deleted");

        }

    } else {

        logger.log("deleteReference from registry failed");

    } else {

        logger.log("deleted fail")

    }

}


如果我们使用异常捕获代替错误码,这样逻辑就得到了简化:

try {

    deletePage(page);

    registry.deleteReference(page.name);

    keys.deleteKey(page.name.makeKey() ;

}

catch(Exception e) {

    logger.log(e.getMessage());

}

三、

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

推荐阅读更多精彩内容