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

如您所知,javadoc工具具有高度的灵活性,并允许许多配置选项。Ant通过javadoc任务公开了这些配置选项。如果您不熟悉javadocs,建议您从此Java Documentation 教程开始。

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

属性

可以使用sourcepathsourcepathrefsourcefiles指定

  • sourcepath用于指向源文件的文件夹(例如src文件夹)。

  • sourcepathref用于引用路径属性所引用的路径(例如,delegates.src.dir)。

  • 当您要将各个文件指定为逗号分隔列表时,将使用sourcefiles

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

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

您可以过滤javadoc进程以仅显示公共,私有,程序包或受保护的类和成员。这可以通过使用privatepublicpackageprotected属性来实现。

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

您还可以使用group属性将软件包分组在一起,以便于浏览。

放在一起

让我们继续我们的Hello world Fax应用程序主题。让我们将文档目标添加到我们的传真应用程序项目中。

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

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

此外,我们创建了三个组

  • 一个用于我们的源文件夹中的实用程序类,
  • 一个用于用户界面类,以及
  • 一个用于数据库相关的类。

您可能会注意到,数据包组有两个包-Faxapp.entity和Faxapp.dao。

  1. <target name = "generate-javadoc">
  2. <javadoc packagenames = "faxapp.*" sourcepath = "${src.dir}"
  3. destdir = "doc" version = "true" windowtitle = "Fax Application">
  4.  
  5. <doctitle><![CDATA[= Fax Application =]]></doctitle>
  6.  
  7. <bottom>
  8. <![CDATA[Copyright © 2011. All Rights Reserved.]]>
  9. </bottom>
  10.  
  11. <group title = "util packages" packages = "faxapp.util.*"/>
  12. <group title = "web packages" packages = "faxapp.web.*"/>
  13. <group title = "data packages" packages = "faxapp.entity.*:faxapp.dao.*"/>
  14. </javadoc>
  15.  
  16. <echo message = "java doc has been generated!" />
  17. </target>

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

javadoc target标被执行时,它会产生以下结果

  1. C:\>ant generate-javadoc
  2. Buildfile: C:\build.xml
  3.  
  4. java doc has been generated!
  5.  
  6. BUILD SUCCESSFUL
  7. Total time: 10.63 second

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

通常,javadoc文件是作为发行版或软件包目标的一部分生成的。