任何项目都必须提供文档。文档在维护项目中起着重要作用。 Java通过使用内置的 javadoc 工具使文档更容易。通过按需生成文档,Ant变得更加容易。
如您所知,javadoc工具非常灵活,允许许多配置选项。 Ant通过javadoc任务公开这些配置选项。
以下部分列出了Ant中使用的最常用的javadoc选项。
可以使用 sourcepath
sourcepath 用于指向源文件的文件夹(例如src文件夹)。
sourcepathref 是用于引用path属性引用的路径(例如,delegates.src.dir)。
sourcefiles 当您想要将单个文件指定为以逗号分隔的列表时。
使用 destdir 文件夹(例如build.dir)。
您可以通过指定要包含的包名来过滤 javadoc 任务。这是通过使用 packagenames 属性实现的,这是一个以逗号分隔的包文件列表。
您可以过滤javadoc进程以仅显示public,private,package ,或受保护的类和成员。这是通过使用私人,公共,包和受保护属性来实现的。
您还可以告诉javadoc任务使用相应的属性包含作者和版本信息。
您还可以使用组属性,以便易于导航。
让我们继续我们的主题 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文件是作为发布或包目标的一部分生成的。