《代码整洁之道》阅读笔记

有很多人说作为一个程序员,必须看看《代码整洁之道》(clean code),虽然自己也阅读了并实践了一些公司总结的前后端代码规范,但总觉得缺少点什么,这个书与一般的代码规范的区别在于,代码规范记录的是死的条目,拿来直接照着用就可以了,而这本书从一个更深层的角度剖析了如何写出高质量代码的问题。

代码的质量与整洁都成正比,这是整本书的中心,我主要阅读了第一、二、三、四、五章,这些章节的内容与目前的工作内容紧密相关,将以下较为重要的点整理摘录如下。

整洁代码

项目经常在初期进展迅速,但在后期却慢如蜗牛,因为每次的修改都会影响到其他地方的两三处代码,混乱的增加,团队的生产力持续下降,管理层只好增加更多的人手到项目中,但事与愿违,新人并不熟悉系统。
进度和代码质量可能互相矛盾,项目经理护卫项目的进度和需求,开发人员则抱怨需求脱离了最初的设计,哀叹进度太紧张,没法好好干活,制造混乱无助于赶上期限,赶上期限唯一的方法——始终尽可能的保持代码整洁。
写出整洁的代码,需要遵循大量的小技巧,不断去实践以获得“整洁感”。
“破窗理论”也适用于软件项目开发,开到别人不规整的代码,放任自己也参与了破坏活动。

有意义的命名

  1. 名副其实。如果命名需要注释来说明,就不叫名副其实。
  2. 避免误导。hp、aix、sco不应该作为变量名,应为它们是某些平台的专有名称。提防使用不同之处较小的名称,比如XYZContorllerForEfficientHandlingOfStrings和XYZControllerForEffientStorageOfStrings。避免大写O和小写L作为变量名,可能会被看作阿拉伯数字0和1。
  3. 做有意义的区分。不能仅仅为满足编译器的的需要而写代码,代码更重要的是给人来阅读的。
  4. 使用读得出来的名称。
  5. 使用便于搜索的名称。
  6. 使用解决方案领域的名称。只有程序员才会读你的代码。
  7. 不要添加没用的语境。比如说在一个Item类中,不必将主键设置为ItemId.

函数

  1. 尽量避免长函数,函数的第一规则是要短小。if语句 else语句 while语句其中的函数应该只有一行。
  2. "函数应该只做一件事。做好这件事。只做一件事",判断一个函数是否只做了一件事,就是看是否能再拆出一个函数。
  3. 要确保函数只做一件事,要确保函数中的语句都要在同意抽象层级上。
  4. 使用描述性的名称,描述函数做的事。别害怕长名称,长而具有描述性的名称,要比描述性的长注释好。
  5. 最理想的参数数量是零,其次是一,再次是二, 尽量避免三参数函数,有足够多的理由才能用三个以上参数,如果需要多个参数,就说明其中一些参数应该封装为类了。
  6. 使用异常替代返回错误码
  7. 别重复自己。重复可能是软件中一切邪恶的根源,许多原则与实践规则都是为控制和消除重复而创建的。

注释

  1. 注释的恰当用法是弥补我们在用代码表达意图时的遭遇的失败。
  2. 注释存在的时间越久,就离其所描述的代码越远,越来越变得全然错误。
  3. 注释不能美化糟糕的代码。
  4. 最好用代码而不是注释说明来阐述行为
  5. 避免循规式注释 例如 要求每个函数都要有javadoc注释,这样的注释只会搞乱代码,有可能误导读者,javadoc注释额外的形式要求等同于八股文章

垂直格式

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,394评论 25 707
  • 目录及笔记链接 序 丹麦谚语:小处诚实非小事。 建筑师路德维希:神在细节之中。 日本的 5S 哲学: 整理(整理、...
    小镭Ra阅读 1,495评论 3 3
  • Our deepest fear is not that we are inadequate. Our deepe...
    简记微语阅读 225评论 0 0
  • 鲜花是美丽的,因为她娇艳欲滴,馨香阵阵;小草是美丽的,因为他生机勃勃,绿茵茸茸;阳光是美丽的,因为他光芒四射,灿烂...
    爱我所爱的阅读 328评论 4 4
  • 最近突然发现一个问题: 我多数时候是通过移动设备看电子书的,除了没有纸质书给人的质感,不能享受翻书的声音,一切都好...
    三月行者阅读 341评论 0 2