7、代码契约中的小细节与运行时检查

代码契约中的小细节与运行时检查

在软件开发中，代码的质量和可靠性至关重要。然而，很多时候我们会遇到一些隐藏在代码中的小细节，这些小细节可能会导致代码难以使用和维护，甚至引入难以发现的错误。本文将探讨如何避免过度依赖代码中的小细节，并介绍运行时检查和断言的使用。

1. 避免过度依赖小细节

代码中的小细节通常以注释和文档的形式存在，但它们往往容易被忽视。其他工程师在使用代码时，很可能不会完全了解这些小细节所规定的内容。因此，依赖小细节来传达代码契约并不是一种可靠的方式，过度依赖小细节可能会导致代码变得脆弱，容易被误用，从而引发意外问题。

例如，下面的 UserSettings 类代码就存在大量小细节：

class UserSettings {

  UserSettings() { ... }

  // Do not call any other functions until the settings have    #A
  // been successfully loaded using this function.
  // Returns true if the settings were successfully loaded.
  Boolean loadSettings(File location) { ... }

  // init() must be called before calling any other functions, but    #A
  // only after the settings have been loaded usi