讀C#代碼整潔之道筆記02_類、對象和數據結構及編寫整潔函數

1. 組織類

1.1. 每一個介面、類、結構體和枚舉均應當擁有其自身的獨立源文件

1.2. Pascal命名方法命名命名空間

1.3. 測試類定義在獨立的程式集

• 1.3.1. 不同程式集的測試放在不同程式集

• 1.3.2. 程式集名稱的最後附加Tests命名空間

1.4. 公司名稱、產品名稱和縮寫辭彙無須使用複數形式

2. 單一職責原則

2.1. （Single Respon-sibility Principle，SRP）

2.2. 一個類應當只具備一種職責

2.3. 類的職責就是類所具備的功能

3. 從註釋生成文檔

3.1. 源代碼文件的頂部都應當包含版權聲明

3.2. 命名空間、介面、類、枚舉、結構體、方法和屬性都應當包含註釋

4. 內聚

4.1. 高內聚

• 4.1.1. 代碼應恰當分組

4.2. 低內聚

• 4.2.1. 不屬於同一類型的代碼劃歸在一組

• 4.2.2. 職責多於一種的類稱為低內聚類

5. 耦合

5.1. 緊耦合

• 5.1.1. 一個類對另一個類依賴性越強

5.2. 低耦合

• 5.2.1. 相互獨立的類越多

• 5.2.2. 依賴註入技術有助於編寫低耦合且易於測試的整潔代碼

6. 為變化而設計

6.1. 設計變化的內容和方式

6.2. 面向介面編程

• 6.2.1. Interface-Oriented Programming，IOP

• 6.2.2. 有助於編寫多態的代碼

• 6.2.3. 控制反轉可以在必要時替換實現了相同介面的軟體的實現

6.3. 依賴註入（Dependency Injection，DI）

6.4. 控制反轉（Inversion of Control，IoC）

6.5. 解決軟體變更的問題

7. 迪米特法則

7.1. Law of Demeter

7.2. 最少知識原則（The Least Knowledge Principle）

7.3. 一個類對於其他類知道的越少越好

7.4. 意在刪除鏈條式調用（用“.”進行的調用鏈接）

7.5. 可以解除代碼的耦合

7.6. 實現迪米特法則有時是很難的

8. 不可變對象

8.1. 值類型

8.2. 一旦獲得則其值就不再改變

8.3. 容易預測又不會改變

8.4. “最小驚訝原則”（principle of least astonishment，POLA）

9. 對象應當隱藏數據並暴露方法

10. 數據結構體應當暴露數據而無須包含方法

10.1. 結構體和類不同，它們使用值相等而非引用相等來進行比較

10.2. 最好隱藏數據，僅僅通過屬性或方法來訪問數據

11. 函數式編程

11.1. 一種軟體編程方法

11.2. 將計算看作數學計算評估

11.3. LINQ

11.4. readonly struct和不可變數據結構

11.5. 比其他編程類型的方法要短小得多

11.6. 對於面向過程的程式員和麵向對象的程式員來說需要比較艱難的轉變才能適應

12. 保持方法短小

12.1. 最好將方法長度控制在10行之內

12.2. 最佳長度是在4行之內

13. 代碼縮進

13.1. IDE實現

14. 避免重覆代碼

14.1. Don't Repeat Yourself，DRY

14.2. WET即每次都需要編寫的代碼（Write Every Time）

15. 儘可能減少參數數量

15.1. 方法參數數目應當小於三個

15.2. 理想情況下則不需要任何參數

15.3. 使用參數對象的模式進行設計

16. 更改對象狀態是程式缺陷的源泉，尤其是在多線程程式中