Javadocs正在消失

Question

我刚刚创建了一个中等大小的实用程序JAR，供许多其他Eclipse项目使用。我花了大量时间编写乏味的javadocs，这样就可以很好地理解如何使用API。

我使用Ant将所有内容都抛到一个JAR中，现在我将该JAR添加到一个新项目的构建路径中。但是low和behold...when i在我的任何实用类/方法上鼠标操作，弹出的工具提示说：

注意:这个元素既没有附加源，也没有附加Javadoc，因此找不到Javadoc。

这里发生什么事情？解决办法是什么？下面是我的实用程序项目的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附件并提供源jar的位置，将源jar附加到库jar。如果要直接引用项目，也可以提供文件夹位置。

要生成包含javadocs和源代码的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>

参考文献

Answer 2

如果您确实希望发布源，那么johncarl的回答可能是正确的；这是eclipse附加源提供的两个选项中的第一个。如果您不想发布源代码，那么需要生成javadocs，请参阅蚂蚁javadoc任务。使用这种方法，您将有两个jars，一个包含已编译的类，另一个包含文档。在eclipse中，用户将把jar类添加到项目中，然后将javadoc jar附加到它。