如何在沒有良好文檔的情況下學習開源庫API

Question

我最近致力於開源庫openmetaverse，該開源庫被設計爲第二人生查看器的開源替代品。我認爲問題在於它沒有很好的記錄。有時，當我真正在真正的程序中使用它時，我誤解了API，這非常煩人，因爲有時您需要編寫許多代碼。但是如何確保API按照您期望的方式行事？那麼如何在沒有良好文檔的情況下學習新的API？

Answer 1

如果它是一個開源庫，您可能想嘗試檢查API中各種函數的源代碼，並查看是否可以從中找出它的工作原理。代碼中甚至可能會有註釋來解釋稀疏文檔沒有的東西。如果不這樣做，你可以在Web上四處看看，並嘗試找到正在使用的庫的示例，並找出API的各種功能以這種方式執行的功能。

Answer 2

單元測試開源庫API應該是學習它的最好方法。

Answer 3

我鼓勵你使用示例程序來展示API的理想/實際應用。另外，請檢查您的應用程序的工作流程以及它可能具有的需求 - 瞭解等待您的內容對於您查找相關信息至關重要。

如果您有庫的源代碼，我也會嘗試生成UML圖（或任何相關的可視化文件）以查看庫如何在其中工作。

學習有限文檔的圖書館並不是一件容易的事情，但是如果你寫出了你的目標，圖書館的一些演示，以及對圖書館如何在裏面工作的後裔理解，你應該能夠找到線索更快，更高效。