編寫可讀代碼的藝術

前言 1
第1章 代碼應當易于理解 5
是什么讓代碼變得“更好”  6
可讀性基本定理 7
總是越小越好嗎 7
理解代碼所需的時間是否與其他目標有沖突 8
最難的部分 8
第一部分 表面層次的改進 9
第2章 把信息裝到名字里 11
選擇專業(yè)的詞 12
避免像tmp和retval這樣泛泛的名字 14
用具體的名字代替抽象的名字 17
為名字附帶更多信息 19
名字應該有多長 22
利用名字的格式來傳遞含義 24
總結 25
第3章 不會誤解的名字 27
例子：Filter() 28
例子：Clip(text, length) 28
推薦用first和last來表示包含的范圍 29
推薦用begin和end來表示包含/排除范圍 30
給布爾值命名 30
與使用者的期望相匹配 31
例子：如何權衡多個備選名字 33
總結 34
第4章 審美 36
為什么審美這么重要 37
重新安排換行來保持一致和緊湊 38
用方法來整理不規(guī)則的東西 40
在需要時使用列對齊 41
選一個有意義的順序，始終一致地使用它 42
把聲明按塊組織起來 43
把代碼分成“段落” 44
個人風格與一致性 45
總結 46
第5章 該寫什么樣的注釋 47
什么不需要注釋 49
記錄你的思想 52
站在讀者的角度 54
最后的思考——克服“作者心理阻滯” 58
總結 59
第6章 寫出言簡意賅的注釋 60
讓注釋保持緊湊 61
避免使用不明確的代詞 61
潤色粗糙的句子 62
精確地描述函數(shù)的行為 62
用輸入/輸出例子來說明特別的情況 63
聲明代碼的意圖 64
“具名函數(shù)參數(shù)”的注釋 64
采用信息含量高的詞 65
總結 66
第二部分 簡化循環(huán)和邏輯 67
第7章 把控制流變得易讀 69
條件語句中參數(shù)的順序 70
if/else語句塊的順序 71
?:條件表達式（又名“三目運算符”） 73
避免do/while循環(huán) 74
從函數(shù)中提前返回 76
臭名昭著的goto 76
最小化嵌套 77
你能理解執(zhí)行的流程嗎 80
總結 81
第8章 拆分超長的表達式 82
用做解釋的變量 83
總結變量 83
使用德摩根定理 84
濫用短路邏輯 84
例子：與復雜的邏輯戰(zhàn)斗 85
拆分巨大的語句 87
另一個簡化表達式的創(chuàng)意方法 88
總結 89
第9章 變量與可讀性 91
減少變量 92
縮小變量的作用域 94
只寫一次的變量更好 100
最后的例子 101
總結 103
第三部分 重新組織代碼 105
第10章 抽取不相關的子問題 107
介紹性的例子：findClosestLocation() 108
純工具代碼 109
其他多用途代碼 110
創(chuàng)建大量通用代碼 112
項目專有的功能 112
簡化已有接口 113
按需重塑接口 114
過猶不及 115
總結 116
第11章 一次只做一件事 117
任務可以很小 119
從對象中抽取值 120
更大型的例子 124
總結 126
第12章 把想法變成代碼 127
清楚地描述邏輯 128
了解函數(shù)庫是有幫助的 129
把這個方法應用于更大的問題 130
總結 133
第13章 少寫代碼 135
別費神實現(xiàn)那個功能——你不會需要它 136
質疑和拆分你的需求 136
保持小代碼庫 138
熟悉你周邊的庫 139
例子：使用Unix工具而非編寫代碼 140
總結 141
第四部分 精選話題 143
第14章 測試與可讀性 145
使測試易于閱讀和維護 146
這段測試什么地方不對 146
使這個測試更可讀 147
讓錯誤消息具有可讀性 150
選擇好的測試輸入 152
為測試函數(shù)命名 154
那個測試有什么地方不對 155
對測試較好的開發(fā)方式 156
走得太遠 158
總結 158
第15章 設計并改進“分鐘/小時計數(shù)器” 160
問題 161
定義類接口 161
嘗試1：一個幼稚的方案 164
嘗試2：傳送帶設計方案 166
嘗試3：時間桶設計方案 169
比較三種方案 173
總結 174
附錄 深入閱讀 175