Javadoc 正在消失

Question

我刚刚制作了一个中等大小的实用程序 JAR，供许多其他 Eclipse 项目使用。我花了很多时间编写乏味的 javadoc，以便让如何使用 API 变得非常明显。

我使用 Ant 将所有内容放入 JAR 中，现在我将该 JAR 添加到新项目的构建路径中。但是你瞧...当我将鼠标悬停在任何实用程序类/方法上时，弹出的工具提示显示:

Note: this element neither has attached source nor attached Javadoc and hence no Javadoc can be found.

这是怎么回事？解决办法是什么？这是 JAR 到我的实用程序项目中的 dist Ant 目标:

<target name="dist" depends="compile">
    <jar jarfile="dist/testing-utils.jar">
        <fileset dir="bin/main" />
        <fileset dir="src/main/config" />
    </jar>
</target>

我还需要配置什么？!？提前致谢!

Answer 1

java 编译任务(我假设您在“编译”目标中使用该任务)会从 Java 源代码生成字节码。此字节码不会包含设计上的注释，因此您的发行版 jar 不会包含注释。

您可能需要在 Eclipse 中附加源代码以访问 Javadocs。您可以通过右键单击目标 jar，选择属性，选择 Java Source Attachment 并提供源 jar 的位置，将源附加到库 jar。如果您想直接引用您的项目，您还可以提供文件夹位置。

要生成包含 javadoc 和源代码的 Jar，您可以在 ant 中使用以下命令:

<target description="bundle sources in a jar" name="package-sources">
    <jar basedir="src" destfile="build/release/${ant.project.name}-${project.version}-sources.jar"/>
</target>

Reference