如何为现有项目生成带有 ant 的 javadoc？答案

【问题标题】：How to generate javadoc with ant, for an existing project?如何为现有项目生成带有 ant 的 javadoc？
【发布时间】：2010-12-02 12:45:16
【问题描述】：

我想从一个 ant 构建文件创建一个 Javadoc，但我看不到它在哪里。在 build.xml 我有：

  <description>
    A sample build file for this project
  </description>

  <property name="source.dir" location="src"/>
  <property name="build.dir" location="bin"/>
  <property name="doc.dir" location="doc"/>
  <property name="main.class" value="proj1.Proj1"/>

  <target name="init" description="setup project directories">
    <mkdir dir="${build.dir}"/>
    <mkdir dir="${doc.dir}"/>
  </target>

  <target name="compile" depends="init" description="compile java sources">
    <javac srcdir="${source.dir}" destdir="${build.dir}"/>
  </target>

  <target name="run" description="run the project">
    <java dir="${build.dir}" classname="${main.class}" fork="yes">
        <arg line="${args}"/>
    </java>
  </target>

  <target name="clean" description="tidy up the workspace">
    <delete dir="${build.dir}"/>
    <delete dir="${doc.dir}"/>
    <delete>
      <fileset defaultexcludes="no" dir="${source.dir}" includes="**/*~"/>
    </delete>
  </target>

  <!-- Generate javadocs for current project into ${doc.dir} -->
  <target name="doc" depends="init" description="generate documentation">
    <javadoc sourcepath="${source.dir}" destdir="${doc.dir}"/>
  </target>

</project>

Javadoc 位于何处？它是隐藏文件还是放置在该目录中的东西？

【问题讨论】：

标签： java ant build javadoc

【解决方案1】：

如果您使用的是 Eclipse，并且您的源文件位于 ${source.dir}/main 下，则可以这样做：

<target name="doc" depends="init" description="generate documentation">
<delete dir="${doc.dir}" />
<mkdir dir="${doc.dir}" />
    <javadoc destdir="${doc.dir}">
        <fileset dir="${source.dir}/main" />
    </javadoc>
</target>

【讨论】：

顺便说一句，最好把<delete dir="${doc.dir}"/>放在clean部分...

【解决方案2】：

您定义了一个doc 目标，该目标在${doc.dir} 中生成javadoc，该目标设置为doc。

  <!-- Generate javadocs for current project into ${doc.dir} -->
  <target name="doc" depends="init" description="generate documentation">
    <javadoc sourcepath="${source.dir}" destdir="${doc.dir}"/>
  </target>

所以，生成 javadoc 只需运行：

$ ant doc

您会在doc 子目录中找到它。

【讨论】：