为什么JAR文件不包含文档？

Question

我正在编写一个小的Java库，其中包含我通常在大多数android应用程序中包含的相关代码。我决定将库导出为一个jar文件，然后将该文件放到我未来项目的libs文件夹中。

null

现在，当我在我的一个android应用程序中使用这个jar时，除了Doc部分之外，所有的一切都像预期的那样运行。当我悬停在我的库的类和方法上时，我看不到我编写的文档注释。

Q1:我是不是又少了一步？
Q2:jar文件应该没有注释吗？

Answer 1

javadoc是从源代码中的javadoc注释生成的文档。

javadocs可以通过Gradle任务、javadoc命令（如果您安装了Java SDK)和各种其他工具生成。然后您可以使用web浏览器读取它们。

另一方面，IDE通常可以在源代码中呈现javadoc注释，并将其显示为弹出窗口等。（有些人将其称为“javadoc”，但我认为这是夸大了，因为您通常不能像读取javadoc文档那样导航文档。）

（我不使用Android Studio，所以我可以告诉你具体怎么做。不过，我想象IDE的在线帮助解释了怎么做……)

这里的最终目标似乎是以允许程序员看到javadoc注释的方式分发库。

这样做的简单方法是分发源代码。本问答描述了如何让Gradle生成一个包含源代码的单独归档，或者将源代码添加到包含您的编译代码¹的JAR中。

如果这是不可接受的，您可能需要将javadocs生成为HTML并将HTML树作为单独的ZIP文件提供，程序员可以解压缩并用web浏览器读取。或者，将javadocs放到一个网站上。

^{1-我不建议这样做。只想将JAR用作二进制文件的人可能会抱怨“臃肿”。}