《編寫可讀程式碼的藝術》讀書筆記（上）表面層次的改進

最近在看《編寫可讀程式碼的藝術》，在這裡記錄一下點點滴滴

程式碼應當易於理解##

可讀性基本定律：程式碼的寫法應當使被人理解它所需的時間最小化，但並不是越小越好，要注意理解程式碼所需的時間是否與其他目標有衝突

第一部分：表面層次的改進###

• 選擇好的名字
• 寫好的註釋
• 把程式碼整潔的寫成更好的格式

選擇好的名字（名稱語義化）

• 選擇專業的詞 （不使用Get,使用Fetch或者Download等更專業的詞）
• 避免泛泛的名字（例如temp）
• 用具體的名字代替抽象的名字
• 使用字首或字尾來給名字附帶更多資訊
• 決定名字的長度（小的作用域使用短的名字，丟掉沒有用的詞ConvertToString簡介為ToString）
• 利用名字的格式來表達含義（例如大寫代表常量min和max等）

程式碼整潔的寫成更好的格式（提高審美）

• 使用一致的佈局，讓讀者很快就習慣這種風格
• 讓相似的程式碼看上去相似
• 把相關的程式碼行分組，形成程式碼塊

提高程式碼審美的技巧

• 重新安排換行來保持一致和緊湊
• 用方法來整理不規則的東西
• 在需要時使用列對齊
• 選一個有意義的順序始終一致的使用它
• 把宣告按塊組織起來（比如方法和變數宣告應該自成一塊）
• 個人風格的一致性（一致的風格比“正確”的風格更重要）

該寫什麼樣的註釋（註釋物有所值）

• 不要為了註釋而註釋
• 不要給不好的名字加註釋（先把名字改好）
• 記錄你的思想
  • 加入導演評論（自己的見解）
  • 為程式碼中的瑕疵寫註釋（同時可以寫一些要做的事）
  • 給常量加註釋
• 站在讀者角度
• 公佈可能的陷阱
• 全域性觀註釋（團隊的新成員快速熟悉程式碼）
• 總結性註釋
• 克服作者心理阻滯

寫出言簡意賅的註釋（註釋應當有很高的資訊）

• 讓註釋保持緊湊
• 避免使用不明確的代詞
• 潤色粗糙的句子
• 精確的描述函式（方法）的行為
• 宣告程式碼的意圖
• 採用資訊含量高的詞