clean code 读书笔记(一)

一、命名规则

  1. 见名知其意,不要使用magic number
  2. 接口和实现,建议接口不要加大写字母I,接口实现后加Impl, 如ShapeFactory(接口), ShapeFactoryImpl(实现)
  3. 方法名应当动词或动词短语,如postPayment, deletePage, save。对于重载的构造器,使用描述参数的静态工厂方法名。如:
    Complex fulcrumPoint = Complex.FromRealNumber(23.0)
  4. 不要对类名,属性字段添加没有用前缀,可以添加能区分当前字段,类的前缀,如:
    firstName, lastName, street, houseNumber, city, state, zipcode 这些构成了一个地址,其中state不太清楚是什么意思,此时需要加上addrState来表明意思。当然这么多字段,还是将其抽象成Address对象最好。

二、函数

  1. 函数体要尽可能的短小,长度不能过长。
  2. 每个函数只做一件事情。
  3. 函数定义顺序遵循自顶向下的规则。
  4. 尽量消除switch语句,若实际情况无法消除,则将switch语句放入到静态工厂中。
  5. 函数参数尽可能保持在一个或两个,除非有足够的特殊理由才能用三个参数。
  6. 函数参数不能有标识参数,如render(Boolean isSuite) 应拆分成renderForSuite()和renderForSingleTest()
  7. 当函数看起来需要两个,三个或三个以上的时候,就说明其中一些参数需要封装成类了。
  8. 将指令和询问分开。如:
if (attributeExists("username")) {
    setAttribute("username", "rory")
}
  1. 使用异常来代替错误码。
  2. 将try catch中业务逻辑代码块抽离成函数。

三、注释

  1. 尽量不使用注释来解释代码意图,而是使用代码本身来阐述意图。
  2. 值得写的注释:如法律信息,提供信息注释,对意图的解释,warning,TODO,FIXME,说明某些对象的重要性, Java API doc.

四、格式

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,649评论 18 139
  • Scala与Java的关系 Scala与Java的关系是非常紧密的!! 因为Scala是基于Java虚拟机,也就是...
    灯火gg阅读 3,433评论 1 24
  • 《重构》读书笔记 总览 第一部分 第一章从实例程序出发,展示设计的缺陷,对其重构可以了解重构的过程和方法。 第二部...
    白桦叶阅读 2,393评论 2 5
  • 先讲讲博客的兴衰吧。 我的情怀 我接触互联网的那个年代,08年末09年初,也正好是博客由盛转衰的年代,此前万家齐放...
    oldwhale阅读 364评论 0 1
  • 假设现在有一组数据,如下图所示。 方法1:用子查询: 解析: 方法2:用左链接: 方法3:用exists半连接: ...
    王诗敏阅读 616评论 0 0