读《代码整洁之道》前十章有感

    由于工作上的原因,阅读了《代码整洁之道》的前十章,读完之后,心有余悸。之前对自己代码的整洁度还是有点信心的,在变量的定义上、方法名的定义上、方法的编写上和对类分层上,都有特别大的提升修改空间,不禁开始想起之前学习别人的代码,现在才明白一点,他们的设计是有深意的,深感惭愧。

    下面是按照《代码整洁之道》前十章给自己的总结:

1、整洁代码:

让营地比你来时更干净!

2、命名:                                                                                           

①需要名副其实,命名应该告诉你它为什么会存在,它做什么事,应该怎么用。

②避免使用与本意相悖的词。

③名称长短与其作用于大小相对应,若变量或常量可能在代码中多处使用,则应赋予其便于搜索的名称。

④类名和对象应当是名词或名词短语,方法名应当是动词和动词短语。

⑤添加有意义的语境。

⑥别害怕长名称,长而具有描述性的名称比短而费解的名称好 

3、函数:

①函数应该短小,并且更短小。

②函数应该做一件事。做好这件事。只做一件事。

③要确保函数只做一件事,函数的语句都要在同一抽象层级上。

④方法中的参数,尽可能少。若参数过多,可以考虑封装成类。

⑤给函数的命名,应该能较好解释函数的意图,以及参数的顺序和意图。

⑥拒绝布尔型标识参数。例:render(boolean isSuite) ==> renderForSuite() 和 renderForSingleTest()

⑦使用异常代替返回错误码,错误处理代码就能从主路径代码中分离出来得到简化。

4、注释:

①注释应该减少,尽量用代码来阐述自己。

②一段糟糕的代码,注释救不了,还是需要重构。

③注释的最佳用处:法律信息、提供信息的注释、对意图的解释、阐述晦涩难懂的部分、TODO。

5、格式:

①源文件最顶部应该给出高层次概念和算法,直至底层的函数和细节。(向报纸学习)

②关系密切的概念应该互相靠近,避免使用protected。

③声明变量应尽可能靠近其使用位置。

④实体变量应该在类的顶部声明。

⑤相关函数应该放在一块。

⑥概念相关的代码应该放在一起。

6、对象和数据结构:

①对象把数据隐藏于抽象之后,只提供操作数据的函数。数据结构暴露其数据,没有提供有意义的函数。

②(The Law of Demeter)模块不应去了解它所操作的对象内部细节。

7、错误处理:

①使用异常代替返回码。

②不返回null值。

③禁止传入null值。

8、边界:

①善用测试来学习。

9、单元测试:

①善用测试来学习。

②测试代码和生产代码一样重要,应该像生产代码一样保持整洁。

③每一个测试一个概念。

10、类:

①类应该足够短小。

②类的声明顺序:公共静态常量->私有静态变量->私有实体变量->公共方法->私有方法

③单一职责原则:类或模块应该有且仅有一条加以修改的理由。

④内聚:类应该只有少量实体变量,类中的每个方法都应该操作一个或者多个这种变量。类中的方法和变量应该互相依赖、互相结合成一个逻辑整体。

⑤对于一个类的新特性,最好通过拓展系统而非修改现有代码来添加新特性。

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

推荐阅读更多精彩内容

  • 如果需要原文档(因文体限制,部分表格无法呈现)请联系QQ1769090563 本文由中医仲景协会整理收集 《内经选...
    陶墨阅读 34,227评论 0 33
  • 一、整洁代码 A.混乱的代价 1.有些团队在项目初期进展迅速,但有那么一两年的时间却慢去蜗行。对代码的每次修改都影...
    ZyBlog阅读 2,015评论 0 2
  • 0. 内容提要 软件质量,不但依赖于架构及项目管理,而且与代码质量紧密相关。 代码质量与其整洁度成正比。干净的代码...
    nimw阅读 3,807评论 0 3
  • 代码整洁之道 Clean Code 第一章 整洁代码 代码的重要性我们永远抛不掉代码,因为代码呈现了需求的细节。在...
    Pengzh1阅读 1,198评论 0 1
  • 目录及笔记链接 序 丹麦谚语:小处诚实非小事。 建筑师路德维希:神在细节之中。 日本的 5S 哲学: 整理(整理、...
    小镭Ra阅读 1,495评论 3 3