读《编写可读代码的艺术》

编程需要看了这本书,表达的意思虽然可以get到,但翻译让我没有一口气看完,而是断断续续看的,记下了我认为重要的点,以后也会经常看这篇来重构代码。(来自笔者的小吐槽)

第1章 代码应当易于理解

  • 代码的写法应当使别人理解它所需的时间最小化

第一部分 表面层次的改进

第2章 把信息装到名字里

  • 使用专业的单词
  • 避免空泛的名字
  • 使用具体的名字来更细致地描述事物
  • 给变量名带上重要的细节
  • 为作用域大的名字采用更长的名字
  • 有目的地使用大小写、下划线等

第3章 不会误解的名字

  • 避免使用多义性的单词(如filter、length和limit)
  • 定义一个值的上限或下限时,max_和min_是很好的前缀
  • 对于包含的范围,first和last是好的选择
  • 对于包含/排除范围,begin和end是最好的选择

第4章 审美

  • 重新安排换行来保持一致和紧凑
  • 如果多个代码块做相似的事情,尝试让它们有同样的风格
  • 把代码按“列”对齐可以让代码更容易浏览
  • 用空行来把大块代码分成逻辑上的“段落”

第5章 该写什么样的注释

  • 能从代码本身中迅速推断出的事实不需要注释
  • 在这些地方记录下想法(指导性批注,代码中的缺陷,常量为什么是这个值)

第二部分 简化循环和逻辑

第7章 把控制流变得易读

  • 比较的左侧值更倾向于不断变化, 右侧值更倾向于常量
  • if/else语句先处理正确的/简单的情况
  • 不要使用do/while循环和goto

第8章 拆分超长的表达式

  • 德摩根定理
    • not(a or b or c) <=> (not a) and (not b) and (not c)
    • not(a and b and c) <=> (not a) or (not b) or (not c)

第9章 变量与可读性

  • 减少“中间结果”变量
  • 减少每个变量的作用域
  • 只写一次的变量最好

第三部分 重新组织代码

第10章 抽取不相关的子问题

  • 代码库常常有个专门的目录来存放通用代码(比如util)

第11章 一次只做一件事

  • 一次只做一件事的流程
    1. 列出代码所做的所有“任务”,“任务”可以小得如“确保这个对象有效”,或者含糊得如“遍历树中所有节点”
    2. 尽量把这件任务拆分到不同的函数中,或者至少是代码中不同的段落中。

第12章 把想法变成代码

  • 用自然语言描述程序然后用这个描述来帮助你写出更自然的代码

第13章 少写代码

  • 从项目中消除不必要的功能,不要过度设计
  • 重新考虑需求,解决版本最简单的问题,只要能完成工作就行
  • 经常性地通读标准库的整个API,保持对它们的熟悉程度

第四部分 精选话题

第14章 测试与可读性

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

推荐阅读更多精彩内容