cleancode，顾名思义就是整洁的代码，或者说清晰、漂亮的代码，相信大多数工程师都希望自己能写出这样的代码。也许这是个千人千面的话题，每个工程师都有自己的理解。比如我，从一个天天被骂代码写得烂的人，逐渐学习成长，到现在也能写的出“人模人样”的代码来了。这期间算是积累了一点经验心得，想和大家分享，抛砖引玉。本文主要针对面向对象编程的cleancode来阐述，面向过程代码的思路会比较不同，不在本文的讨论范畴。代码大部分时候是用来维护的，而不是用来实现功能的这个原则适用于大部分的工程。我们的代码，一方面是编译好让机器执行，完成功能需求；另一方面，是写给身边的队友和自己看的，需要长期维护，而且大部

CleanCode(代码整洁之道)中英文合集。

Clean Code 代码整洁之道 （英文版+中文版），软件工程参考书电子版，英文原版+中文翻译版。【美】Robert C. Martin 著， 韩磊 译目录：第1章 整洁代码 11.1 要有代码 2 1.2 糟糕的代码 21.3 混乱的代价 31.3.1 华丽新设计 41.3.2 态度 41.3.3 迷题 51.3.4 整洁代码的艺术 51.3.5 什么是整洁代码 61.4 思想流派 101.5 我们是作者 111.6 童子军军规 121.7 前传与原则 12 1.8 小结 121.9 文献 13第2章 有意义的命名 152.1 介绍 152.2 名副其实 162.3 避免误导 172.4 做有意义的区分 182.5 使用读得出来的名称 192.6 使用可搜索的名称 20 2.7 避免使用编码 212.7.1 匈牙利语标记法 212.7.2 成员前缀 212.7.3 接口和实现 222.8 避免思维映射 222.9 类名 232.10 方法名 232.11 别扮可爱 232.12 每个概念对应一个词 242.13 别用双关语 242.14 使用解决方案领域名称 252.15 使用源自所涉问题领域的名称 252.16 添加有意义的语境 252.17 不要添加没用的语境 272.18 最后的话 27第3章 函数 293.1 短小 323.2 只做一件事 333.3 每个函数一个抽象层级 343.4 switch语句 353.5 使用描述性的名称 363.6 函数参数 373.6.1 一元函数的普遍形式 383.6.2 标识参数 383.6.3 二元函数 383.6.4 三元函数 393.6.5 参数对象 393.6.6 参数列表 403.6.7 动词与关键字 403.7 无副作用 403.8 分隔指令与询问 423.9 使用异常替代返回错误码 42 3.9.1 抽离Try/Catch代码块 433.9.2 错误处理就是一件事 443.9.3 Error.java依赖磁铁 443.10 别重复自己 443.11 结构化编程 453.12 如何写出这样的函数 453.13 小结 453.14 SetupTeardownIncluder程序 46 3.15 文献 48第4章 注释 494.1 注释不能美化糟糕的代码 504.2 用代码来阐述 514.3 好注释 514.3.1 法律信息 514.3.2 提供信息的注释 514.3.3 对意图的解释 524.3.4 阐释 53 4.3.5 警示 534.3.6 TODO注释 544.3.7 放大 544.3.8 公共API中的Javadoc 554.4 坏注释 554.4.1 喃喃自语 554.4.2 多余的注释 564.4.3 误导性注释 584.4.4 循规式注释 584.4.5 日志式注释 59 4.4.6 废话注释 594.4.7 可怕的废话 614.4.8 能用函数或变量时就别用注释 624.4.9 位置标记 624.4.10 括号后面的注释 624.4.11 归属与署名 634.4.12 注释掉的代码 634.4.13 HTML注释 644.4.14 非本地信息 644.4.15 信息过多 654.4.16 不明显的联系 65 4.4.17 函数头 664.4.18 非公共代码中的Javadoc 664.4.19 范例 664.5 文献 69第5章 格式 715.1 格式的目的 725.2 垂直格式 725.2.1 向报纸学习 735.2.2 概念间垂直方向上的区隔 73 5.2.3 垂直方向上的靠近 745.2.4 垂直距离 755.2.5 垂直顺序 795.3 横向格式 795.3.1 水平方向上的区隔与靠近 805.3.2 水平对齐 815.3.3 缩进 825.3.4 空范围 845.4 团队规则 845.5 鲍勃大叔的格式规则 85第6章 对象和数据结构 87 6.1 数据抽象 876.2 数据、对象的反对称性 896.3 得墨忒耳律 916.3.1 火车失事 916.3.2 混杂 926.3.3 隐藏结构 926.4 数据传送对象 936.5 小结 94 6.6 文献 94第7章 错误处理 957.1 使用异常而非返回码 9

clean code-代码整洁之道(中文完整版-带书签).pdf