Javadocs正在消失

时间:2011-12-23 21:27:00

标签: java eclipse ant javadoc

我刚刚发布了一个中型实用程序JAR,供许多其他Eclipse项目使用。我花了很多时间编写繁琐的javadoc,这样很明显如何使用API​​。

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

  

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

这里发生了什么?解决方案是什么?这是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>

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

2 个答案:

答案 0 :(得分:3)

java编译任务,我假设你在“编译”目标中使用,从Java源代码生成字节码。此字节码不会包含设计注释,因此您的分发jar不会包含注释。

您可能正在寻找的是在Eclipse中附加源以获取对Javadoc的访问权限。您可以通过右键单击目标jar,选择属性,选择Java Source Attachment并提供源jar的位置,将源附加到库jar。如果要直接引用项目,还可以提供文件夹位置。

要生成包含javadoc和source的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

答案 1 :(得分:0)

如果你确实想发货,那么johncarl的回答可能是正确的;它是eclipse提供的两个选项中的第一个 - 附加源。如果您想要发送源代码,那么您需要生成javadocs,请参阅ant javadoc task。使用这种方法,您将拥有两个罐子,一个包含已编译的类,另一个包含文档。在eclipse中,您的用户会将类jar添加到项目中,然后将javadoc jar附加到它。