documentation - 您如何决定阅读哪些 API 函数文档以及阅读的认真程度？

Question

假设您正在编写或维护一段代码，该代码使用了一些您不是 100% 熟悉的 API。

你如何决定是否阅读某个调用目标的文档，以及花费多少时间阅读它？你怎么决定不读它？

（假设您可以通过打开 HTML 文档、检查源代码或使用 IDE 中的悬停机制来阅读它）。

Answer 1

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

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

• 该函数的作用很容易从名称中猜到。
• 它与我正在维护的代码无关：例如，您正在检查某些代码如何删除文件，并且您有一些显然会更新 UI 的功能。你暂时不关心这个。
• 如果调试：该函数没有以对手头任务有意义的方式更改程序状态。和以前一样，如果您正在调试删除代码，您不想了解 SetOverlayIcon 的作用，因为它会因文件系统错误而死。
• API 只是你已经知道的 API 的一个特例，你可以猜出这个特例是什么，以及特殊参数（如果有的话）做什么。例如，假设您有 WriteToFile(string filename) 和 WriteToFile(string filename, boolean overwrite)。

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