2022-10-14-读《代码整洁之道》

《设计模式之禅》读完。开始重读《代码整洁之道》。

命名

  • 用有意义的名字,不用无意义的字符
  • 名字要能够读出来,比如一个表明年月日的变量,不要用 ymd,要用 yearMonthDay
  • 避免误导,不是 List 结构名字就不要有 list,不用小写英文 l、大写英文 O,和数字 01 傻傻分不清楚
  • 如果一个名字要在很多地方用到,不要太短,要便于搜索,比如一个名字叫 a,那一搜到处都是这字符,基本上不可能定位到想找的名字
  • 变量名不用加 m 前缀,不能提供更多的信息,是冗余
  • 接口名不用添加前缀 I,不用让人特地知道它是接口,原因可能是实现者不一定和接口同名,那样就不需要区分,所以加 I 属于冗余,只有某些情况实现者也用那个名字时,那就给实现者加后缀 Impl

函数

  • 函数要尽可能短小,越小越好,每个函数只负责一件事
  • 函数的选择、循环里只写一句话,调用其他方法,这要求有点高
  • try/catch 里的代码单独抽出一个方法,这结构很丑陋,所以要短小些,catch 之后不要有其他语句,也就要求这个函数只做这个异常处理
  • 函数名不怕长,要尽可能提供明确的描述,用动词
  • 参数越少越好,如果多要考虑源头分拆多个调用,单一职责要求的必然后果
  • 参数很多时,考虑将其封装成对象,这样参数意义更明确
  • 参数不要用布尔值,而是调用者自己判断,然后调用两个不同的方法,意义分得更明确。这就实践中做取舍了,完全这样感觉不太现实
  • 指令与询问分开,要么做一件事,要么返回一件布尔值,只做一件事。太苛刻了,但是如果真的这么严格的话确实可读性变高了
  • 不要有重复代码,若有就单独抽取一个函数
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,794评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,050评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,587评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,861评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,901评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,898评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,832评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,617评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,077评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,349评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,483评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,199评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,824评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,442评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,632评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,474评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,393评论 2 352

推荐阅读更多精彩内容

  • 整洁代码 Leblanc : Later equals never.(勒布朗法则:稍后等于永不) 对代码的每次修改...
    foever_f1eb阅读 806评论 0 0
  • 一、整洁代码 A.混乱的代价 1.有些团队在项目初期进展迅速,但有那么一两年的时间却慢去蜗行。对代码的每次修改都影...
    ZyBlog阅读 2,032评论 0 2
  • [TOC] 代码整洁之道-理论 前言 学习中、工作中遇到很多乱七八糟的糟糕代码,自己入门时也写过不少糟糕代码。在一...
    丁永辉Dave阅读 325评论 0 1
  • 目录及笔记链接 序 丹麦谚语:小处诚实非小事。 建筑师路德维希:神在细节之中。 日本的 5S 哲学: 整理(整理、...
    小镭Ra阅读 1,496评论 3 3
  • 一、整洁的代码 整洁的代码从不隐藏设计者的意图,充满了干净利落的抽象和直截了当的控制语句。 读写的花费时间比例超过...
    我爱学习_学习使我快乐阅读 366评论 0 0