24、编写高质量代码：防误用与模块化实践

编写高质量代码：防误用与模块化实践

1. 让代码难以被误用

代码若易于被误用，那么在某个时刻就极有可能被错误使用，进而导致出现 bug。常见的代码被误用的情况有以下几种：
- 调用者提供无效输入。
- 其他代码产生的副作用。
- 调用者未在正确的时间或顺序调用函数。
- 相关代码的修改破坏了原有假设。

为了减少代码被误用的可能性，我们可以设计和构建代码，使其难以或无法被误用。例如， IntListFormat 类为存储序列化整数的格式提供了单一事实来源，这几乎完全消除了工程师可能更改 DataLogger 类使用的格式，却无意中忘记更改 DataLoader 类使用的格式的风险。当不同代码段执行的逻辑需要匹配时，我们应确保重要的逻辑片段有单一事实来源，这样能大大降低因不同代码段之间不同步而导致的 bug 风险。

下面是相关的代码结构示例：

Logging some values to a file
Serializing a list of integers
Loading some values from a file
Deserializing a list of integers
Format for storing serialized integers
DataLoader class
High - level problem
Subproblems
DataLogger class
IntListFormat class

<