读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. 更改对象状态是程序缺陷的源泉，尤其是在多线程程序中