如何构建我的jar文件,以便使用该库的用户能够在Eclipse中看到javadoc

时间:2011-03-31 08:19:48

标签: java ant javadoc javac

我正在为一个小型图书馆工作,供我们在公司内部使用,并且已经大量记录了它。现在我用以下代码构建我的jar:

<project name="commonutils" default="compile" basedir="."> 

    <property name="src" location="src" />

    <property name="build" location="buildDirecotry" />

    <target name="compile">
        <delete file="${ant.project.name}.jar" />
        <mkdir dir="${build}"/>
        <javac srcdir="${src}" destdir="${build}" debug="on" target="1.5">
            <classpath>
                <pathelement location="lib/build/server.zip" />
                <pathelement path="${java.class.path}/"/>
            </classpath>
        </javac>
        <jar basedir="${build}" destfile="${ant.project.name}.jar" />
        <delete dir="${build}" />
    </target>

</project>

哪个工作正常,它用我的所有src文件构建我的jar文件,但是当我在另一个项目中包含jar文件时,我不再拥有任何我的javadoc注释。使用JDDecompiler我看不到类文件中的注释,虽然我不确定它的java编译器是剥离它还是JD。

我的问题是:如何构建我的jar文件,以便使用该库的用户能够在Eclipse中看到javadoc。

2 个答案:

答案 0 :(得分:2)

AFAIK文档是一个Eclipse功能。您必须手动配置它。在您的构建中生成文档(通常在文件夹'javadoc'中)并将其与JAR打包。一旦有人想要使用你的库,他/她必须进入Java Build Path选择库,添加你的,点击它旁边打开树节点,然后双击Javadoc位置进行配置。

答案 1 :(得分:2)

如果您将源文件包含在jar中(每个类和java文件位于同一个package-directory中),它应该可以工作。

<target name="jar.noCompile.src">  
    <jar destfile="${ant.project.name}.jar">  
      <fileset dir="${build}"/>  
      <fileset dir="${src}" includes="**/*.java"/>  
    </jar>  
</target>