您如何决定阅读哪些API函数文档以及如何认真对待？

Question

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

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

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

Answer 1

理想情况下，你应该阅读所有，但我们知道......你知道这很痛苦。我通常在这些案件上做的事情（我在做自由职业者的过程中做了很多）是重要的因素，取决于结果，我阅读了文档。

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

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

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