编写可读代码的艺术

O'Reilly精品图书系列 编写可读代码的艺术 The Art of Readable Code [美]Dustin Boswell [美]Trevor Foucher 著 尹哲 郑秀雯 译 ISBN：978-7-111-38544-8 本书纸版由机械工业出版社于2012年出版，电子版由华章分社（北京华 章图文信息有限公司）全球范围内制作与发行。 版权所有，侵权必究 客服热线：+ 86-10-68995265 客服信箱：service@bbbvip.com 官方网址：www.hzmedia.com.cn 新浪微博 @研发书局 腾讯微博 @yanfabook 目 录 O'Reilly Media,Inc.介绍 业界评论 译者序 前言 本书内容安排 如何阅读本书 代码示例的使用 联系我们 致谢 第1章 代码应当易于理解 是什么让代码变得“更好” 可读性基本定理 总是越小越好吗 理解代码所需的时间是否与其他目标有冲突 最难的部分 第一部分 表面层次的改进 第2章 把信息装到名字里 选择专业的词 找到更有表现力的词 避免像tmp和retval这样泛泛的名字 tmp 循环迭代器 对于空泛名字的裁定 用具体的名字代替抽象的名字 例子：DISALLOW_EVIL_CONSTRUCTORS 例子：——run_locally（本地运行） 为名字附带更多信息 带单位的值 附带其他重要属性 名字应该有多长 在小的作用域里可以使用短的名字 输入长名字——不再是个问题 首字母缩略词和缩写 丢掉没用的词 利用名字的格式来传递含义 其他格式规范 总结 第3章 不会误解的名字 例子：Filter() 例子：Clip(text,length) 推荐用min和max来表示（包含）极限 推荐用first和last来表示包含的范围 推荐用begin和end来表示包含/排除范围 给布尔值命名 与使用者的期望相匹配 例子：get*() 例子：list:size() 例子：如何权衡多个备选名字 总结 第4章 审美 为什么审美这么重要 重新安排换行来保持一致和紧凑 用方法来整理不规则的东西 在需要时使用列对齐 你应该用列对齐吗 选一个有意义的顺序，始终一致地使用它 把声明按块组织起来 把代码分成“段落” 个人风格与一致性 总结 第5章 该写什么样的注释 什么不需要注释 不要为了注释而注释 不要给不好的名字加注释——应该把名字改好 记录你的思想 加入“导演评论” 为代码中的瑕疵写注释 给常量加注释 站在读者的角度 意料之中的提问 公布可能的陷阱 “全局观”注......