为什么我们需要 javadoc 和源 jar？

Question

一般来说，发布库的时候，我们需要同时使用

sources.jar

和

javadoc.jar

吗？我不太明白

javadoc.jar

的用途。如果是关于代码文档，IDE可以从

sources.jar

本身显示它。

示例：

请注意，这不是 javadoc.jar、sources.jar 和 .jar 之间有什么区别？的重复。我正在寻找

javadoc.jar

能做什么，而

sources.jar

不能做什么。

Answer 1

我来一一解答一下问题：

如果可以使用sources.jar，为什么javadoc.jar还存在？

这个问题基本上是针对开发者的。如果无法共享源（例如，它可能是专有的），共享文档仍然会有所帮助。

为什么开发商两者都提供？

一个非常简单的原因可能是因为这是 Maven、Gradle 等的默认设置。

另一个原因可能是某些组织出于安全原因（或其他原因）不允许访问源代码，或者不能/不想自己构建 HMTL 文件，而只是托管它们。

如果我可以使用sources.jar，为什么作为开发人员需要将javadoc.jar导入到我的IDE中？

我想说你不需要。作为一名开发人员，我经常发现拥有可用于调试等的源代码非常有用，所以我更喜欢 source.jar。

Answer 2

源 JAR 和 Javadoc JAR 具有根本不同的用途。

• 源 JAR 将允许 IDE 提供代码完成的解决方案、必需和可选参数及其相应类型的列表等。示例：Jenkins 服务器的源
• Javadoc JAR 提供了所使用的 API 的基于 Web 的百科全书。因此，如果有人对所有各种构造函数调用感到好奇，可以阅读相关内容。如果人们对继承层次结构感到好奇，他们可以轻松地浏览 HTML 格式的文档。值得注意的是，IDE 可能会提供 Javadoc 作为摘录并链接到源解决方案的文档，但也不显示相互关系或详细信息。 示例： Jenkins 服务器的 Javadoc

所开发产品的完整表示应包括

source

和

javadoc

，以明确上述原因。

Answer 3

生成 javadoc 的工具可能不是使用标准

doclet

生成的，因此使用源进行渲染可能不合需要。由于您的 IDE 可能无法理解如何呈现作者选择放入源代码中的格式。