Ant构建文档

   

文档是一个为任何项目所必须的。文档在项目的维护起到了极大的作用。通过使用内置的javadoc工具的Java使得文档更容易。Ant使得它甚至产生对需求文档更容易。

如你所知,javadoc工具具有高度的灵活性,并允许一些配置选项。Ant通过Javadoc任务公开这些配置选项。如果您不熟悉javadoc,建议在开始使用此Java文档教程。

以下部分列出了使用的Ant最常用的Javadoc选项。

属性

源可以使用源路径,sourcepathref或将源文件的规定。源路径是用来指向源文件(如src文件夹)的文件夹。 Sourcepathref用于参考,是由路径属性(例如,delegates.src.dir)引用的路径。而当你要指定的单个文件以逗号分隔的列表时的源文件使用。

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

你可以由指定要包含在包名过滤Javadoc任务。这是通过使用packagenames属性来实现,用逗号分隔的包文件列表。

你可以过滤javadoc的过程中,只显示了公共,私有,包装或保护类和成员。这是通过使用(不奇怪)的私有,公共,封装和保护的属性来实现。

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

你也可以组包一起使用的组属性,因此,它是易于浏览。

全部放在一起

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

下面是我们的项目中使用的例子Javadoc任务。

 <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>

在这个例子中,我们指定使用对于src.dir作为源目录和文档作为目标目录中的javadoc。我们还定制了窗口标题,页眉和出现的Java文档页面上的页脚信息。

此外,我们已经创建了三组。一个用于为用户界面类和一组数据库相关类在我们的源文件夹,一组实用程序类。你可能会注意到数据包组有两个包 – faxapp.entity和faxapp.dao。

运行javadoc的Ant任务现在将生成并放置在doc文件夹中的Java文档文件。

当执行javadoc target,它会产生以下结果:

 C:/>ant generate-javadoc Buildfile: C:/build.xml  java doc has been generated!  BUILD SUCCESSFUL Total time: 10.63 second

Java文档文件现在出现在doc文件夹。

通常情况下,产生的释放或包的目标部分的Javadoc文件。

   
本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » Ant构建文档

分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址