8、代码使用与代码契约的关键要点

代码使用与代码契约的关键要点

1. 他人如何了解代码的使用方法

当其他工程师需要使用或修改依赖于你的代码时，他们需要弄清楚如何使用你的代码以及它的功能。具体而言，他们需要理解以下几点：
- 在哪些场景下调用你提供的各种函数。
- 你创建的类代表什么，以及何时使用它们。
- 调用函数时应传入什么值。
- 你的代码将执行什么操作。
- 你的代码可以返回什么值。

为了弄清楚如何使用你的代码，其他工程师可以采取以下几种方法：
|方法|描述|可靠性|
| ---- | ---- | ---- |
|查看名称|查看函数、类、枚举等的名称|较高|
|查看数据类型|查看函数和构造函数的参数类型以及返回值类型|较高|
|阅读文档|阅读非正式的函数和类级注释、更正式的代码内文档（如 JavaDoc）、外部文档（如 README.md、网页或带有说明的文档）|一般|
|亲自询问|直接询问你如何使用代码|较低|
|查看代码|查看代码的具体实现细节|较低|

1.1 查看名称

在实践中，查看名称是工程师了解如何使用新代码的主要方法之一。包、类和函数的名称就像书籍的目录，是找到解决子问题的代码的便捷快速方式。例如，如果一个函数名为 removeEntry() ，就很难将其与名为 addEntry() 的函数混淆。因此，给事物起好名字是向其他工程师传达代码使用方法的最佳方式之一。

1.2 查看数据类型

如果操作正确，查看数据类型是确保代码正确使用的非常可靠的方法。在任