javadoc正在消失



我刚刚创建了一个中等大小的实用程序JAR,供许多其他Eclipse项目使用。我花了大量的时间编写乏味的javadocs,以便很明显地知道如何使用这个API。

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

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

这是怎么回事?解决办法是什么?下面是jar up我的实用程序项目的dist Ant目标:

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

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

java编译任务(我假设您在"compile"目标中使用它)从java源代码生成字节码。这个字节码将不包含注释,因此您的发行版jar将不包含注释。

您可能正在寻找的是在Eclipse中附加源代码以访问Javadocs。您可以通过右键单击目标jar,选择属性,选择Java source Attachment并提供源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>
参考

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

相关内容

  • 没有找到相关文章

最新更新