為什么我們需要 javadoc 和源代碼 jar？

Question

一般在發布庫的時候，是不是同時需要sources.jar和javadoc.jar ？ 我不太明白javadoc.jar的用途。如果是關於代碼文檔，IDE 可以從sources.jar本身顯示它。

示例：

請注意，這不是What are the differences between javadoc.jar, sources.jar and.jar 的副本？ . 我正在尋找javadoc.jar可以做什么， sources.jar不能做什么。

Answer 1

讓我一一回答問題：

如果可以使用 sources.jar，為什么 javadoc.jar 甚至存在？

這個問題基本上是針對開發人員的。 如果無法共享資源（例如，它可能是專有的），共享文檔仍然會有幫助。

為什么開發人員同時提供兩者？

一個非常簡單的原因可能是因為這是 Maven、Gradle 等的默認值。

另一個原因可能是某些組織出於安全原因（或其他原因）不允許訪問源代碼，或者不能/不想自己構建 HTML 文件，而只是托管它們。

如果我可以使用 sources.jar，為什么我作為開發人員需要將 javadoc.jar 導入我的 IDE？

我會說你不應該需要。 作為一名開發人員，我經常發現將源代碼用於調試等非常有用，所以我更喜歡 source.jar。

Answer 2

來源 JAR 和 Javadoc JAR 用於根本不同的目的。

• 源 JAR 將允許 IDE 提供代碼完成的解決方案、必需和可選的列表 arguments 及其相應的類型等。示例： Jenkins 服務器的源
• Javadoc JAR 提供了正在使用的 API 的基於 Web 的百科全書。 因此，如果有人對所有各種構造函數調用感到好奇，可以閱讀它。 如果有人對 inheritance 層次結構感到好奇，他們可以很容易地瀏覽 HTML 格式的文檔。 值得注意的是，IDE 可能會提供 Javadoc 作為摘錄並鏈接到源解決方案的文檔，但也不會顯示相互關系或細節。 示例： Jenkins 服務器的 Javadoc

出於上面詳述的精確解釋原因，針對其開發的產品的完整表示應包括source和javadoc 。