文檔是一個為任何項目所必須的。文檔在項目的維護起到了極大的作用。通過使用內置的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:uild.xml

java doc has been generated!

BUILD SUCCESSFUL
Total time: 10.63 second

Java文檔文件現在出現在doc文件夾。

通常情況下，產生的釋放或包的目標部分的Javadoc文件。