【程序员必须知道的事】代码整洁之道

《代码整洁之道》推荐给每一位有志于写出优秀代码的程序员,这是一本我从事程序开发多年后,所读到的对我触动颇深,相见恨晚之作。不夸张的说,这应该作为每一个程序工作者初入职场的必读之作。当然关于读书,任何时候起步都不算晚。本书,Martin大神会告诉你,好代码的意义,并教你如何写好代码。
下面结合自己多年工程实践的经验和书中作者的观点,整理出以下简单易记的代码整洁之道,愿帮助到大家写出简洁优雅的代码。
代码整洁的意义?
整洁的代码便于阅读,传承,维护。
整洁的代码直接关乎团队生产效率的提升,甚至关乎团队存亡。
什么是整洁代码?
整洁的代码应该可以由作者之外的开发者阅读,增补,它应该有单元测试和验收测试,它使用有意义的命名。它只提供一种而非多久做一件事情的途径,它只有尽量少的依赖关系,而且要明确地定义和提供清晰、尽量少的API。
如何写出整洁代码?

注释:

  1. 消除冗余注释,无意义的注释,尽量用有意义的变量名,有意义的方法名来达到代码注释的效果,因为维护注释很困难
  2. 注释掉的代码,用版本管理工具管理代码,当前无用的代码,果断删掉,这种腐烂掉的代码会严重污染所属模块,影响代码的可读性,阻碍代码阅读者准确的理解代码

函数:

  1. 函数的参数应尽量少,参数过多时改考虑是否应该抽取对象了
  2. 避免输出参数(将输入的参数作为输出结果的载体,比如输入一个空的 hashmap,然后再函数中填充hashmap值)
  3. 避免传入bool 变量的参数 ,这会影响代码的可读性,传入bool变量说明函数做了不止一件事情(违背SRP单一职责原则)比如:setSwitchStatus(On/Off) ===> 拆为: switchOn() switchOff()
  4. 死函数,删除永不调用的函数

一般性问题:

  1. DRY (don't repeat yourself) 避免代码重复,当出现代码重复时,意味着遗漏了抽象
  2. 死代码 永远不会执行的代码应该删掉
  3. 前后不一致问题,变量命名规则,框架的使用,代码风格,一旦确定,坚决贯彻
  4. 使用解释性变量
  5. 函数名应该表达其行为
  6. 用多态代替 switch/if/else
  7. 用命名常量代替Magic number
  8. 封装条件,if (true)… 最好修改为 if (fileExist(..))….
  9. 一个函数只做一件事情( SRP) 优点解耦,更灵活
  10. 掩盖时序耦合,如果几个函数有调用时序关系,请通过参数或者返回值的形式建立他们的时序关系,比如:每个函数产生下一个函数所需要的结果
  11. 封装边界条件,比如 if(currentPage > 10) … 最好改为if(isLastPage(currentPgae) 这样阅读者更容易读懂代码的意图
  12. 避免传递性浏览(墨忒耳律),如果A与B协作,B与C协作,避免A.getB.getC 这样的操作,而应该直接用B.doSomething() 将与C 相关的逻辑封 装在B 的 方法里面
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,185评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,445评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,684评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,564评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,681评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,874评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,025评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,761评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,217评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,545评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,694评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,351评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,988评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,778评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,007评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,427评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,580评论 2 349

推荐阅读更多精彩内容

  • 一、整洁代码 A.混乱的代价 1.有些团队在项目初期进展迅速,但有那么一两年的时间却慢去蜗行。对代码的每次修改都影...
    ZyBlog阅读 2,027评论 0 2
  • [TOC] 代码整洁之道-理论 前言 学习中、工作中遇到很多乱七八糟的糟糕代码,自己入门时也写过不少糟糕代码。在一...
    丁永辉Dave阅读 320评论 0 1
  • 整洁代码 Leblanc : Later equals never.(勒布朗法则:稍后等于永不) 对代码的每次修改...
    foever_f1eb阅读 795评论 0 0
  • 海到无边天作岸,山登绝顶我为峰。作为猿类的我们,对自己创造的代码有着一种天生的无比自信。这是好事~可是,对于我们的...
    独钓寒江雪_520阅读 1,007评论 0 0
  • 一、整洁的代码 整洁的代码从不隐藏设计者的意图,充满了干净利落的抽象和直截了当的控制语句。 读写的花费时间比例超过...
    我爱学习_学习使我快乐阅读 365评论 0 0