代码整洁之道(Clean Code)读书笔记

第一章

什么是整洁代码

  1. 没有重复的代码
  2. 利于后期维护
  3. 高内聚,低耦合
  4. 包含尽量少的实体,如类,方法,函数
  5. 能通过所有的测试
第二章

类,函数,参数以及目录文件的命名规则(做有意义的命名)

  1. 做有意义的区分

以数字命名是依义命名的对立面,如item1,item2...根据参数的含义命名;

不要使用含义相近的函数命名,如getUserInfo,getUser等意义含混的命名;

  1. 使用可以读的出来的单词(英语单词不要使用自造词)
  2. 使用可搜索的名称(用var声明全局的大写变量)
  3. 避免使用编码
  4. 避免思维映射(使用读者可懂的命名)
  5. 类名

避免使用Data,Info这样没有标志性的名词;

使用名词或名词短语;

尽量简短;

7.方法名

使用动词或动词短语;

依Javabean标准加上set,get,is前缀;

  1. 每个概念对应一个词
  2. 别用双关语(如add,使用append,insert代替)
  3. 添加有意义的语境

firstName,lastName,street改为addrFirstName,addrLastName,addrStreet

  1. 不要添加没用的语境
第三章

函数

  1. 短小
  2. 代码块和缩进
  3. 只做一件事
  4. 每个函数一个抽象层级(自顶向下读代码,向下规则)
  5. switch语句(写在类的继承关系中)
  6. 使用描述性的名称
  7. 函数参数

标志参数:参数类型为boolean,应该拆成两个函数

二元函数:转换成一元函数处理(写成当前类的成员变量)

参数对象:如果有两个,三个或三个以上的参数,把其中一些参数封装成类

参数列表:向函数传入数量可变的参数({...args})

动词与关键字:函数名称以及参数名称的命名

  1. 无副作用
  2. 错误处理

把try/catch里面的代码块抽象成一个函数。catch/finally后面不应该有任何代码

  1. 不要重复自己
第四 五章

注释与格式

  1. 尽量少的注释
  2. 代码格式:可读性与可维护性
  3. 垂直格式:自顶向下的规则,用空白行表示一个独立概念的开始
  4. 横向格式:每行代码的长度尽量短小
第六章

对象和数据结构

第七章

错误处理

第八章

边界

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