你如何決定閱讀哪些API函數文檔以及如何認真對待？

Question

假設您正在編寫或維護一段使用某些您不是100％熟悉的API的代碼。

你如何決定是否閱讀某個呼叫目標的文件，以及有多少時間花在讀書呢？你如何決定不讀它？

（假設你可以打開HTML文件，檢查源代碼，或者使用在IDE中懸停機制閱讀）。

Answer 1

理想情況下，您應該閱讀全部，但是我們知道這是...您知道的痛苦。我通常在這些案例中做過的事情（並且我在做自由職業者時做了很多工作）是重要的一些因素，並且取決於結果，我閱讀了文檔。

因素告訴我，我不應該閱讀文檔：

• 什麼功能確實很容易從名字猜測。
• 它與我所維護的代碼無關：例如，您正在檢查某些代碼如何刪除文件，並且您有一些顯然會執行一些UI更新的功能。你現在不關心。
• 如果調試：該功能沒有以對當前任務有意義的方式更改程序狀態。和以前一樣，如果您正在調試刪除代碼，因爲它正在死於文件系統錯誤，您不想了解SetOverlayIcon的功能。
• API只是您已知的API的一個特例，您可以猜出特例是什麼，以及特殊參數（如果有）。例如，假設您有WriteToFile（字符串文件名）和WriteToFile（字符串文件名，布爾覆蓋）。

當然，一切都取決於上下文，所以即使這些規則也有例外。