Ant - 构建文档

在任何项目中，文档都是必须的。 文档在项目维护中起着重要作用。 Java 通过使用内置的 javadoc 工具使文档变得更容易。 Ant 通过按需生成文档使其变得更加容易。

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

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

属性

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

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

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

• sourcefiles 用于将单个文件指定为逗号分隔列表。

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

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

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

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

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

把它们放在一起

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

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

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

另外，我们创建了三个组 −

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

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

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

您可能会注意到数据包组有两个包——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 文件是作为发布或包目标的一部分生成的。