设计原则小结
Here are the most important software design principles discussed in this book:
- Complexity is incremental: you have to sweat the small stuff (see p. 11).
- Working code isn’t enough (see p. 14).
- Make continual small investments to improve system design (see p. 15).
- Modules should be deep (see p. 22)
- Interfaces should be designed to make the most common usage as simple as possible (see p. 27).
- It’s more important for a module to have a simple interface than a simple implementation (see pp. 55, 71).
- General-purpose modules are deeper (see p. 39).
- Separate general-purpose and special-purpose code (see p. 62).
- Different layers should have different abstractions (see p. 45).
- Pull complexity downward (see p. 55).
- Define errors (and special cases) out of existence (see p. 79).
- Design it twice (see p. 91).
- Comments should describe things that are not obvious from the code (see p. 101).
- Software should be designed for ease of reading, not ease of writing (see p. 149).
- The increments of software development should be abstractions, not features (see p. 154).
这是本书中讨论的最重要的软件设计原则：
- 复杂性是逐步增加的：您必须努力处理小事情（请参阅 2.4）。
- 能跑起来的的代码是不够的（请参阅 3.2）。
- 持续进行少量投资以改善系统设计（请参阅 3.3）。
- 模块应较深（请参见 4.4）
- 接口的设计应尽可能简化最常见的用法（请参阅 4.7）。
- 一个模块具有一个简单的接口比一个简单的实现更重要（请参阅 第八章, 9.8）。
- 通用模块更深入（请参阅 第六章）。
- 通用和专用代码分开（请参见 9.4）。
- 不同的层应具有不同的抽象（请参见 第七章）。
- 降低复杂度（请参阅 第八章）。
- 定义不存在的错误（和特殊情况）（请参阅 10.3）。
- 设计两次（请参阅 第十一章）。
- 注释应描述代码中不明显的内容（请参见 第十三章）。
- 软件的设计应易于阅读而不是易于编写（请参见 18.2)）。
- 软件开发的增量应该是抽象而不是功能（请参见 19.2）。
危险信号小结
Here are a few of of the most important red flags discussed in this book. The presence of any of these symptoms in a system suggests that there is a problem with the system’s design:
- Shallow Module: the interface for a class or method isn’t much simpler than its implementation (see pp. 25, 110).
- Information Leakage: a design decision is reflected in multiple modules (see p. 31).
- Temporal Decomposition: the code structure is based on the order in which operations are executed, not on information hiding (see p. 32).
- Overexposure: An API forces callers to be aware of rarely used features in order to use commonly used features (see p. 36).
- Pass-Through Method: a method does almost nothing except pass its arguments to another method with a similar signature (see p. 46).
- Repetition: a nontrivial piece of code is repeated over and over (see p. 62).
- Special-General Mixture: special-purpose code is not cleanly separated from general purpose code (see p. 65).
- Conjoined Methods: two methods have so many dependencies that its hard to understand the implementation of one without understanding the implementation of the other (see p. 72).
- Comment Repeats Code: all of the information in a comment is immediately obvious from the code next to the comment (see p. 104).
- Implementation Documentation Contaminates Interface: an interface comment describes implementation details not needed by users of the thing being documented (see p. 114).
- Vague Name: the name of a variable or method is so imprecise that it doesn’t convey much useful information (see p. 123).
- Hard to Pick Name: it is difficult to come up with a precise and intuitive name for an entity (see p. 125).
- Hard to Describe: in order to be complete, the documentation for a variable or method must be long. (see p. 131).
- Nonobvious Code: the behavior or meaning of a piece of code cannot be understood easily. (see p. 148).
这是本书中讨论的一些最重要的危险信号。系统中任何这些症状的存在表明系统的设计存在问题：
- 浅模块：类或方法的接口并不比其实现简单得多（请参见第 25、110 页）。
- 信息泄漏：设计决策反映在多个模块中（请参阅第 31 页）。
- 时间分解：代码结构基于执行操作的顺序，而不是信息隐藏（请参见第 32 页）。
- 过度暴露：API 强制调用者注意很少使用的功能，以便使用常用功能（请参阅第 36 页）。
- Pass-Through Method：一种方法几乎不执行任何操作，只是将其参数传递给具有相似签名的另一种方法（请参见第 46 页）。
- 重复：一遍又一遍的重复代码（请参见第 62 页）。
- 特殊通用混合物：特殊用途代码未与通用代码完全分开（请参阅第 65 页）。
- 联合方法：两种方法之间的依赖性很大，以至于很难理解一种方法的实现而又不理解另一种方法的实现（请参阅第 72 页）。
- 注释重复代码：注释旁边的代码会立即显示注释中的所有信息（请参阅第 104 页）。
- 实施文档污染了界面：界面注释描述了所记录事物的用户不需要的实施细节（请参阅第 114 页）。
- 含糊不清的名称：变量或方法的名称过于精确，以至于它不能传达很多有用的信息（请参阅第 123 页）。
- 难以选择的名称：很难为实体提供准确而直观的名称（请参见第 125 页）。
- 难以描述：为了完整起见，变量或方法的文档必须很长。（请参阅第 131 页）。
- 非显而易见的代码：一段代码的行为或含义不容易理解。（请参阅第 148 页）。
