假设我们正在编写或者维护一段使用我们并非100％熟悉的API的代码。

我们如何决定是否阅读某个致电目标的文档，以及花多少时间阅读该文档？我们如何决定不阅读它？

(假设我们可以通过打开HTML文档，检查源代码或者使用IDE中的悬停机制来阅读它)。

解决方案

理想情况下，我们应该阅读所有内容，但是我们知道这对我们来说是很痛苦的。我通常在这些情况下所做的事情(在我作为自由职业者时做了很多事情)是权衡一些因素，并且根据结果，我阅读了文档。

告诉我我不应该阅读文档的因素：

• 函数的功能很容易从名称中猜测出来。
• 这与我要维护的代码无关：例如，我们正在检查一些代码如何删除文件，并且我们具有一些显然可以进行某些UI更新的功能。我们暂时不在乎。
• 如果进行调试：该函数不会以对手头任务有意义的方式更改程序状态。和以前一样，如果我们正在调试删除代码，因为它因文件系统错误而死，则我们不想了解SetOverlayIcon的功能。
• API只是我们已经知道的API的特例，我们可以猜测特例是什么，以及特殊参数(如果有)的作用。例如，假设我们有WriteToFile(字符串文件名)和WriteToFile(字符串文件名，布尔值覆盖)。

当然，一切都取决于上下文，因此即使这些规则也有例外。