代码整洁之道个人总结

代码整洁之道总结

1.switch语句

    写出短小的switch很难,即便是只有两种条件的switch语句也要比单个代码块和函数大得多,写出制作一件事的switch也很难。当switch条件增多时,代码还会变长。它明显做了不止一件事,违反了单一职权原则和开放闭合原则。

    遇到此类问题的解决方案是:将switch语句埋到工厂底下,不让任何人看到,该工厂使用switch语句为实体的派生物创建适当的实体,而不同的函数。

2.函数参数

    最理想的参数数量是零(零参数函数),其次是一(单参数函数),再次是二(双参数函数),应尽量避免三(三参数函数),有足够特殊的理由才能用三个以上参数(多参数函数)。

3.使用异常替代返回错误码

    从指令式函数返回错误码轻微违反了指令与询问之间的规则,它鼓励了在if语句判断中把指令当做表达式使用。这不会引起动词/形容词混淆,但却导致更深层次的嵌套结构。当返回序错误码时,就是在要求调用者立刻处理错误。

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

4.抽离Try/Catch代码块

Try/Catch代码块搞乱了代码结构,把错误处理与正常流程混为一谈,最好把try和catch代码块的主题部分抽离出来,另外形成函数。

5.注释

有些注释是必须的,也会有利的。唯一真正还的注释是想尽办法不去写的注释。

6.垂直位置(垂直格式)

变量声明:变量声明应尽可能靠近其使用位置,因为函数很短,本地变量应该在函数的顶部出现。

1)实体变量:实体变量应该在顶部声明,这不会增加变量的垂直距离,因为在设计中,它们如果不是被该类的所有方法也是被大多数方法所用。

2)相关函数:若某个函数调用了另外一个,就应该把他们放到一起,而且调用者应该尽可能放在被调用者上面,这样,程序就有了自然顺序。若鉴定遵守这条约定,读者将能够确信函数声明总会在其代用后很快出现。

3)概念相关:概念相关的代码应该放到一起。相关性越强,彼此之间的距离就该越短。相关性应建立在直接依赖度额基础上,如函数间调用,或函数使用某个变量,但也有其他相关性的可能,相关性可能来自于执行相似操作的已足以函数。

7.横向格式

一行代码应该有多宽?应该尽量保持代码行短小,死守80个字符的上限,最长代码行达到100个字符到120个字符。

8.整洁的测试

做到测试可读的方式:明确、简洁、还有足够的表达力,在测试中,以尽可能少的文字表达大量的内容。

整洁测试遵循的规则:

1)快速:测试运行速度快。

2)独立:测试应该相互独立。

3)可重复:测试应当可在任何环境中重复通过。

4)自足验证:测试应该有布尔输出值。

5)及时:测试应及时编写。

9.类的组织

遵循标准的Java约定,类应该从一组变量列表开始,如果有公共静态常量,应该先出现,然后是私有静态变量,以及私有实体变量,很少会有公共变量。

类的名名称应当描述其权责,命名正是帮助判断类的长度的第一手段。如果无法为某个类命以准确的名称,这个类大概太长了,类名越含混,该类就有可能拥有过多权责。(系统应该由许多短小而不是少量巨大的类组成,每个小类封装成一个权责,只有一个修改的原因,并与少数其他类一起协同达成期望的系统行为。)

1)单一权责原则

单一权责原则,类或模块应有且只有一条加以修改的理由。该原则既给出了权责的定义,又是类的长度的指导方针。类只应有一个权责(只有一条修改的理由)。

2)内聚

类应该只有少量实体变量,类中的每个方法第应该操作一个或多个这种变量。方法操作的变量越多,就越粘聚到类上,如果一个类中的每个变量都被每个方法所使用,则该类具有最大的内聚性。

10.并非编程

发生思索的4个条件

1)互斥

无法在同一时间为多个线程所用,数量上有限制

2)上锁及等待

当某个线程获取一个资源,在获取到其他全部所需资源并完成其工作之前,不会释放这个资源。

3)无抢先机制

线程无法从其他线程处夺取资源,一个线程持有资源时,其他线程获得这个资源的唯一手段就是等待该线程释放资源。

4)循环等待

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

推荐阅读更多精彩内容

  • 一、整洁代码 A.混乱的代价 1.有些团队在项目初期进展迅速,但有那么一两年的时间却慢去蜗行。对代码的每次修改都影...
    ZyBlog阅读 2,036评论 0 2
  • @[TOC](代码整洁之道Clean Code笔记) 在线阅读:书栈网:https://www.bookstack...
    好奇新阅读 287评论 0 0
  • 整洁代码 Leblanc : Later equals never.(勒布朗法则:稍后等于永不) 对代码的每次修改...
    foever_f1eb阅读 806评论 0 0
  • [TOC] 代码整洁之道-理论 前言 学习中、工作中遇到很多乱七八糟的糟糕代码,自己入门时也写过不少糟糕代码。在一...
    丁永辉Dave阅读 329评论 0 1
  • 代码整洁之道 Clean Code 第一章 整洁代码 代码的重要性我们永远抛不掉代码,因为代码呈现了需求的细节。在...
    Pengzh1阅读 1,213评论 0 1