《代碼整潔之道》讀書筆記

  1. 函數要盡可能短小,最好不要超過20行。而且函數應該做一件事,做好這件事,只做這一件事。
  2. 函數參數盡可能的少,建議一般不要超過三個。如果函數看來需要兩個、三個或三個以上參數,就說明其中一些參數應該封裝為類了。
  3. 對于一元函數,函數和參數應當形成一種非常良好的動詞/名詞對形式。如,write(name)
  4. 函數要么做什么事,要么回答什么事,但二者不可得兼。函數應該修改某對象的狀態,或是返回該對象的有關信息。兩樣都干常會導致混亂。
  5. 函數是語言的動詞,類是名詞。
  6. 如果可能盡量不寫注釋,而是讓變量和函數本身見名知意。
  7. 暫時未完成的部分使用TODO注釋,讓開發工具將未完成的部分放到工作列表。
  8. 沒必要在代碼里添加歸屬與署名,因為源代碼控制系統已經幫我們做了這些事,完全沒必要讓這樣的注釋搞臟代碼。
  9. 不要保留注釋掉的代碼,代碼被注釋掉說明是無用的。源代碼控制系統會記錄這些刪掉的代碼,不用擔心找不回來。
  10. 自上向下展示函數調用依賴順序,被調用的函數應該放在執行調用的函數下面。
  11. 每行代碼不要超過120個字符,而最佳長度為80到100個字符。
  12. 對象暴露行為,隱藏數據。便于添加新對象類型而無需修改既有行為,同時也難以在既有對象中添加新行為。數據結構暴露數據,沒有明顯的行為。便于向既有數據結構添加新行為,同時也難以向既有函數添加新數據結構。
  13. 定義一個函數最好別返回null值。返回null值基本上是再給自己增加工作量,也是在給調用者添亂。如果你打算在方法中返回null值,不如拋出異常,或是返回特例對象。如果你在調用某個第三方API中可能返回null值的方法,可以考慮用新方法打包這個方法,在新方法中拋出異常或是返回特例對象。

以上是《代碼簡潔之道》前十章的讀書筆記。只記錄了筆者認為在實際工作用比較實用的部分,沒有長篇大論的摘抄。主要用于閱讀備忘,方便以后復習。


本文作者: Sheh偉偉
本文鏈接: http://davidsheh.github.io/2016/03/03/「代碼整潔之道」讀書筆記/
版權聲明: 本博客所有文章除特別聲明外,均采用 CC BY-NC-SA 3.0 許可協議。轉載請注明出處!

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,908評論 6 541
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,324評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,018評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,675評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,417評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,783評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,779評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,960評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,522評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,267評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,471評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,009評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,698評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,099評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,386評論 1 294
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,204評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,436評論 2 378

推薦閱讀更多精彩內容