Ant - 構建文件

文件在任何專案中都是必不可少的。文件在專案的維護中起著重要的作用。Java 透過使用內建的javadoc工具使文件編制更容易。Ant 透過根據需要生成文件使其更加容易。

如您所知，javadoc 工具非常靈活，並允許許多配置選項。Ant 透過 javadoc 任務公開這些配置選項。如果您不熟悉 javadoc，我們建議您從本 Java 文件教程開始。

以下部分列出了 Ant 中最常用的 javadoc 選項。

屬性

可以使用sourcepath、sourcepathref或sourcefiles指定原始碼。

sourcepath用於指向原始檔所在的資料夾（例如 src 資料夾）。
sourcepathref用於引用由 path 屬性引用的路徑（例如，delegates.src.dir）。
sourcefiles用於當您想將各個檔案指定為逗號分隔列表時。

使用destdir資料夾（例如 build.dir）指定目標路徑。

您可以透過指定要包含的包名稱來過濾javadoc任務。這是透過使用packagenames屬性（包檔案的逗號分隔列表）實現的。

您可以過濾 javadoc 過程，以僅顯示公共、私有、包或受保護的類和成員。這是透過使用private、public、package和protected屬性實現的。

您還可以透過使用相應的屬性告訴 javadoc 任務包含作者和版本資訊。

您還可以使用 group 屬性將包組合在一起，以便於導航。

綜合示例

讓我們繼續我們Hello world傳真應用程式的主題，並向我們的傳真應用程式專案新增一個文件目標。

下面是在我們的專案中使用的 javadoc 任務示例。在此示例中，我們已指定 javadoc 使用src.dir作為源目錄，並使用doc作為目標。

我們還自定義了出現在 Java 文件頁面上的視窗標題、頁首和頁尾資訊。

此外，我們建立了三個組：

一個用於原始檔夾中的實用程式類，
一個用於使用者介面類，以及
一個用於資料庫相關類。

您可能會注意到 data 包組有兩個包 -– 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 檔案作為釋出或包目標的一部分生成。

列印頁面