Ant - 构建文档

文档在任何项目中都是必不可少的。文档在项目的维护中起着重要的作用。Java 通过使用内置的javadoc工具使文档编制更容易。Ant 通过根据需要生成文档使其更加容易。

如您所知，javadoc 工具非常灵活，并允许许多配置选项。Ant 通过 javadoc 任务公开这些配置选项。如果您不熟悉 javadoc，我们建议您从本 Java 文档教程开始。

以下部分列出了 Ant 中最常用的 javadoc 选项。

属性

可以使用sourcepath、sourcepathref或sourcefiles指定源代码。

• sourcepath用于指向源文件所在的文件夹（例如 src 文件夹）。

• sourcepathref用于引用由 path 属性引用的路径（例如，delegates.src.dir）。

• sourcefiles用于当您想将各个文件指定为逗号分隔列表时。

使用destdir文件夹（例如 build.dir）指定目标路径。

您可以通过指定要包含的包名称来过滤javadoc任务。这是通过使用packagenames属性（包文件的逗号分隔列表）实现的。

您可以过滤 javadoc 过程，以仅显示公共、私有、包或受保护的类和成员。这是通过使用private、public、package和protected属性实现的。

您还可以通过使用相应的属性告诉 javadoc 任务包含作者和版本信息。

您还可以使用 group 属性将包组合在一起，以便于导航。

综合示例

让我们继续我们Hello world传真应用程序的主题，并向我们的传真应用程序项目添加一个文档目标。

下面是在我们的项目中使用的 javadoc 任务示例。在此示例中，我们已指定 javadoc 使用src.dir作为源目录，并使用doc作为目标。

我们还自定义了出现在 Java 文档页面上的窗口标题、页眉和页脚信息。

此外，我们创建了三个组：

• 一个用于源文件夹中的实用程序类，

• 一个用于用户界面类，以及

• 一个用于数据库相关类。

您可能会注意到 data 包组有两个包 -– faxapp.entity 和 faxapp.dao。

<target name="generate-javadoc">
   <javadoc packagenames="faxapp.*" sourcepath="${src.dir}"
      destdir="doc" version="true" windowtitle="Fax Application">
      <doctitle><![CDATA[= Fax Application =]]></doctitle>
      <bottom>
         <![CDATA[Copyright © 2011. All Rights Reserved.]]>
      </bottom>
      <group title="util packages" packages="faxapp.util.*"/>
      <group title="web packages" packages="faxapp.web.*"/>
      <group title="data packages" packages="faxapp.entity.*:faxapp.dao.*"/>
   </javadoc>
   <echo message="java doc has been generated!" />
</target>

让我们执行 javadoc Ant 任务。它生成并将 Java 文档文件放在 doc 文件夹中。

执行javadoc 目标时，会产生以下结果：

C:\>ant generate-javadoc
Buildfile: C:\build.xml

java doc has been generated!

BUILD SUCCESSFUL
Total time: 10.63 second

Java 文档文件现在存在于doc文件夹中。

通常，javadoc 文件作为发布或包目标的一部分生成。