编写可读代码的艺术--摘要

第一章 代码应当易于理解

  • 是什么让代码变得“更好”
  • 可读性基本定理代码的写法应当使别人理解它所属时间最小化)**
  • 总是越小越好吗

第二章 把信息装到名字里

  • 选择专业的词
    找到更有表现力的词(清晰和精确比装可爱好
  • 避免像tmp和retval这样泛泛的名字
    tmp(tmp这个名字只应用于短期存在且临时性为其主要存在因素的变量
    循环迭代器
    对于空泛名字的裁定
  • 用具体的名字代替抽象的名字
  • 为名字附带更多信息
    带单位的值
    附带其它重要属性
  • 名字应该有多长
    在小的作用域里可以使用短的名字
    输入长名字--不再是个问题
    首字母缩略词和缩写(团队新成员是否能够理解其含义?
    丢掉没用的词
  • 利用名字的格式来传递含义
  • 其他格式规范

第三章 不会误解的名字

要多问自己几遍:“这个名字会被别人解读成其他的含义吗?”要仔细审视这个名字。

  • 推荐用min和max来表示(包含)极限
  • 推荐用first和last来表示包含的范围
  • 推荐用begin和end来表示包含/排除范围
  • 给布尔值命名(加上is、has、can或should这样的词,可以把布尔值变得更明确
  • 与使用者的期望相匹配

第四章 审美

三原则:

  • 使用一致的布局,让读者很快就习惯这种风格。

  • 让相似的代码看上去相似。

  • 把相关的代码行分组,形成代码块。

  • 为什么审美这么重要

  • 重新安排换行来保持一致和紧凑

  • 用方法来整理不规则的东西

  • 在需要的时使用列对齐(你应该使用列对齐吗?

  • 选一个有意义的顺序,始终一致地使用它

  • 把声明按块组织起来

  • 把代码分成“段落”

  • 个人风格与一致性

第五章 该写什么样的注释

注释的目的是尽量帮助读者了解得和作者一样多。

  • 什么不需要注释(不要为那些从代码本身就能快速推断事实写注释
    不要为了注释而注释
    不要给不好的名字加注释——应该把名字改好
  • 记录你的思想
    加入“导演评论“
    为代码中的瑕疵写注释
    给常量加注释
  • 站在读者的角度
    意料之中的提问
    公布可能的陷阱
    ”全局观“注释
    总结性注释
  • 最后的思考——克服”作者心理阻滞“
    不管你心里想什么,先把它写下来
    读一下这段注释,看看有没有什么地方可以改进
    不断改进
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,757评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,478评论 1 289
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,540评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,593评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,903评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,329评论 1 210
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,659评论 2 309
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,383评论 0 195
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,055评论 1 238
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,337评论 2 241
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,864评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,227评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,820评论 3 231
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,999评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,750评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,365评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,260评论 2 258

推荐阅读更多精彩内容