Clean Code 读书笔记

最近开始跟着程序员练级攻略重新读书,第一本翻起的就是Clean Code这本书,记得刚毕业的时候草草读过,当时心里想的这些不都是废话么,真正看了写了几年代码后再看,又有一些新的体验,对于有些看似废话的东西也就心有戚戚焉了。

为命名添加有意义的语境
我个人比较推崇Verbose的命名方式,因为单看代码就能理解类或者函数干了什么,所以比如类A的方法B,有时候我会用AB这种命名方式,当类A名字很长而且有很多命名差不多的方法时,这样命名就会产生一些差别非常细微的方法,类似SuperLongNameClassGetFirstSuperImportantValue和SuperLongNameClassGetLastSuperImportantValue。其实真正有区分度的就是First和Last这两个单词,但是之前无意义的前缀导致很难区分这两个方法,即便使用了IDE的自动补全有时也会手抖写错。这种情况以后确实不应该再加上没有意义的前缀A。

函数应该无副作用
曾经踩过这个问题的大坑,我记得我在公司的代码库里见过这样的代码。
当时我还奇怪为什么每次调用总能得到值,后来看到实现简直吐血了。这种get函数就是明显的有副作用的代码,一般人的理解get就是有就返回,没有返回null值,但是上面的函数没有时额外帮你创建了一个并且放到了map里。这种难以估计的副作用会令调用者的debug过程异常痛苦。

public @Nullable AwesomeClass get(Object key) {
    AwesomeClass awesomeClass = map.get(key);
    if (awesomeClass == null) {
      awesomeClass = new AwesomeClass();
      map.put(key, awesomeClass);
    }
    return awesomeClass;
}

注释
我非常非常赞同作者对于注释的看法,注释并不能美化糟糕的代码。我在公司的代码库里见到过很多超长的注释,它详细解释了一些令人一头雾水的操作的来龙去脉,乍一看你可能会觉得作者非常负责任,但注释最大的问题就是很多情况下注释并不会随着代码一直更新。当这种超长的注释解释的代码经过几次移动和更新后,即便作者本人也并不能确定的说明注释所说的情况是不是还是有效的。久而久之,这种超长注释和它所对应的代码就变成了代码库中的magic code,没人能解释也没人敢修改。下次当我发现我需要写很长的注释才能解释一些代码的时候,也许直接重构代码是一个更好的选择。

未完待续

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