返回首页
当前位置: 主页 > 编程语言 > JAVA教程 >

蚂蚁-构建文档

时间:2020-06-26 12:24来源:电脑教程学习网 www.etwiki.cn 编辑:小山哥

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

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

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

属性

可以使用sourcepathsourcepathrefsourcefiles指定

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

  • sourcepathref用于引用路径属性所引用的路径(例如,委托人.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。

<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文件是作为发行版或软件包目标的一部分生成的

------分隔线----------------------------
标签(Tag):
------分隔线----------------------------
推荐内容
  • 蚂蚁-创建JAR文件

    编译Java源文件之后,下一步的逻辑步骤是构建Java归档文件,即JAR文件。 使用 jar 任...

  • 蚂蚁-构建文档

    在任何项目中,文档都是必须的。 文档在项目维护中起着重要作用。 Java通过使用内置的...

  • 蚂蚁-建筑项目

    现在我们已经了解了Ant中的数据类型,是时候将这些知识付诸实践了。 我们将在本章中构...

  • Ant-数据类型

    Ant提供了许多预定义的数据类型。 不要将术语数据类型与编程语言中可用的那些混淆,而...

  • 蚂蚁-属性文件

    如果要使用少数几个属性,则可以直接在构建文件中设置属性。 但是,对于大型项目,将...

  • 蚂蚁-属性任务

    Ant构建文件是用XML编写的,它不允许像使用您喜欢的编程语言一样声明变量。 但是,正...

猜你感兴趣