代码整洁之道

第一章 整洁代码

        1. 面对历史混乱代码,期限压力,我们不得不在代码优雅和进度间进行妥协

        2. 我们总安慰自己,以后会重新构建,使之更整洁,但大多不会发生,Later equals never

        3. 混论代码更容易犯错误,不得不花大量时间修复,修复为了赶进度,引入更多混乱。

        4. 什么是整洁的代码:

            1. 代码逻辑直截了当,2. 减少依赖,3. 完善错误处理 ,4.性能调至最优

        5. 童子军军规:让营地比你来时更干净

第二章 有意义的命名

        1. 名副其实,类,函数名,变量名应该告诉你他是谁,他为什么存在,应该怎么用,如果名称需要注释补充,那它就名副其实。

        2. 避免误导,避免使用错误,有多重意义,易引起误会的词。

        3. 要有区分,要以读者能够区分为标准,避免废话。

        4. 使用可以读出来的名称

        5. 使用可以搜索的名称

        6. 避免使用编码,避免映射思维

        7. 类名应该是名词或名词短语,方法名应该是动词或动词短语,别扮可爱

        8. 每个概念对应一个词,别用双关语

        9. 使用解决方案领域的名称,使用源自解决问题领域的名称

        10. 添加有意义的语境,不要添加没用的

第三章 函数

        1. 短小, 只做一件事,函数语句都在一个抽象层次

        2. swicth 语句,确保switch 都埋藏在较低的抽象层级,且用不重复

        3. 使用描述性名称,函数参数尽量少,无副作用,尽量避免时序上的耦合

        4. 分割指令与询问,使用异常代替返回值

        5. 别重复自己

        6. 可以先写再打磨它,分解函数,修改名称,消除重复等

第四章 注释

        1. 注释不能美化糟糕的代码

        2. 用代码来阐述

        3. 好注释:  

        4. 坏注释

第四章 格式

        1. 格式很重要,格式关乎沟通,沟通是程序开发的大事,而不是让代码能工作,代码风格影响到可读性和可维护性。

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

推荐阅读更多精彩内容