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

发布于 2024-10-28 15:02:15 字数 1038 浏览 0 评论 0原文

我正在开发一个供公司内部使用的小型库,并对其进行了大量记录。现在我正在使用以下代码构建我的 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。

I'm working on a small library for our in-company use, and have been heavily documenting it. Now I'm building my jar with the following code:

<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>

Which works fine, it builds my jar file with all the src files in it, but when I include the jar file in another project I no-longer have any of my javadoc comments. Using JDDecompiler I cannot see the comments in the class file, although I'm not sure if its the java compiler that's stripping them or JD.

My question is: How can I build my jar file so that users who use the library will be able to see the javadoc in Eclipse.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

本宫微胖 2024-11-04 15:02:15

如果您将源文件包含在 jar 中(每个类和 java 文件都在同一包目录中),它应该可以工作。

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

If you include the source files in the jar (each class and java file in the same package-directory) it should work.

<target name="jar.noCompile.src">  
    <jar destfile="${ant.project.name}.jar">  
      <fileset dir="${build}"/>  
      <fileset dir="${src}" includes="**/*.java"/>  
    </jar>  
</target>  
情何以堪。 2024-11-04 15:02:15

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

AFAIK the documentation is an Eclipse feature. You have to configure it manually. In your build generate the documentation (usually into folder 'javadoc') and package it with the JAR. Once someone wants to use your library, he/she has to go into Java Build Path select libraries, add yours, click next to it to open the tree node and then double click on Javadoc location to configure it.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文