在 JAR 文件中包含文档答案

【问题标题】：Include documentation in a JAR file在 JAR 文件中包含文档
【发布时间】：2013-04-03 14:12:11
【问题描述】：

使用 Eclipse 可以将文档文件夹附加到 jar 文件中，以便在编程时查看 jar 类的文档。我的问题是：是否可以直接将文档包含到jar文件中，以避免程序员每次需要使用jar文件时都链接两个部分？（所以让我只分发一个 jar 文件，而不是带有 jar 及其文档的 zip 文件）。

编辑

最终结果：不可能。 :(

【问题讨论】：

标签： eclipse jar documentation javadoc

【解决方案1】：

我不明白“直接包含文档”是什么意思，但是您可以将任何内容放入 jar 文件中。如果您使用 ant（它可以在 Eclipse 中），只需为您的分发构建创建一个目标并将文档文件夹传递给 Jar task。

  <jar destfile="${dist}/lib/app.jar">
    <fileset dir="${build}/classes"
             excludes="**/Test.class"
    />
    <fileset dir="${src}/documentation"/>
  </jar>

【讨论】：

是的，我知道我可以将我想要的内容放入 jar 文件中。我想知道的是是否可以避免手动将 jar 文件与其文档链接。
是的，您可以 - 自定义您的构建脚本。我的答案中的 sn-p 改编自链接上的示例。它将创建一个包含${build}/classes 文件夹内容的jar 文件，不包括任何名为Test.class 的文件和${src}/documentation 的内容。我不知道你是否在 Eclipse 中使用 Ant。我不使用 Eclipse，但知道您可以自定义构建脚本（即使您不使用 Ant，也可以使用 Maven 或任何其他构建系统来实现这一点）。
我成功地将 doc 文件放入 jar 文件中。问题是如果 jar 文件没有与 jar 文件显式链接，文档仍然不可见...
我不明白“如果 jar 文件没有与 jar 文件显式链接”的意思。它是否为您的项目创建了一个 jar，其中包含 javadocs，并从您尚未创建的文件中读取 javadocs？
现在我明白了。我认为没有其他方法可以完全自动地做到这一点。在Preferences -> Java -> Build Path -> User Libraries 中，您可以创建可以保存各种 jar 文件的用户库。在那里您可以定义 javadoc 的位置。并将其“导入”到您的项目中，javadoc 将已经链接。