Javadoc 產生

這個精靈可讓您產生「Javadoc 產生」。 這是 javadoc.exe 工具的使用者介面,可在 Java JDK 中找到。 請造訪 Sun's Javadoc Tool 網頁,以取得 Javadoc 工具的完整文件。

第一頁

類型選項:

選項

說明

選取要產生 Javadoc 的類型

在清單中,勾選或清除勾選框,以明確指定要匯出到 JAR 檔中的類型。 這份清單會根據工作台中的選擇項來初值設定。 您一次只能選取一個專案,這是因為在執行 Javadoc 工具時, 一次只能使用一個專案的類別路徑。

為設有 visibility 的成員建立 Javadoc

  • Private:將記載所有成員
  • Package:只記載設有 default、protected 或 public visibility 的成員
  • Protected:只記載設有 protected
  • Public:只記載設有 public visibility 的成員(這是預設值)


使用標準 doclet

以標準 doclet 啟動 Javadoc 指令(預設值)

  • 目的地:請選取一個目的地, 以便讓標準 doclet 將所產生的文件寫到這裡。目的地是 doclet 特定的引數, 因此如果您使用自訂 doclet,將不會啟用。


使用自訂 doclet

使用自訂 doclet 來產生文件

  • Doclet 名稱:doclet 的完整類型名稱
  • Doclet 類別路徑: doclet 類別所需的類別路徑


標準 doclet 引數

標準 Doclet 引數(當選取了使用標準 doclet 時就可使用):

選項

說明

文件標題

指定文件的標題。
產生「使用」頁面 如果您想讓文件中包含一個「使用」頁面,請選取這個選項。
產生階層樹狀結構 如果您想讓文件中包含一個「樹狀結構」頁面,請選取這個選項。

產生導覽器列

如果您想讓文件中包含一個導覽列(標頭與標底),請選取這個選項。
產生索引 如果您想讓文件中包含一個「索引」頁面,請選取這個選項。
每個字母各產生一個索引 每個字母各建一個索引。當選取了產生索引時,表示已啟用。 
@author 如果您想闡明 @author 標示,請選取這個選項。
@version 如果您想闡明 @version 標示,請選取這個選項。
@deprecated 如果您想闡明 @deprecated 標示,請選取這個選項。
已停用的清單 如果您想讓文件中包含一個「已停用」頁面,請選取這個選項。 當選取了 @deprecated 選項,就表示已啟用。
選取 Javadoc 應建立鏈結的參照類別 指出當有參照其他類型時,Javadoc 應建立和其他哪些文件的鏈結。
  • 全選:建立和其他所有文件位置間的鏈結
  • 全部清除:不建立和其他文件位置間的鏈結
  • 配置:配置所參照之 JAR 或專案的 Javadoc 位置。
樣式表 選取所要使用的樣式表

一般引數

一般 Javadoc 選項:

選項

說明

概觀

指出 Javadoc 應從所提供的檔案中擷取概觀文件的文字。 將放在 overview-summary.html 檔中。

其他的 Javadoc 選項

在這裡新增其他選項(數量不限):自訂 doclet 選項、VM 選項、JRE 1.4 相容性選項等。
請注意,如果引數中含有空格,則必須括上引號。在指定 HTML 程式碼的引數(例如:-header)方面, 請使用   或 ",以避免使用空格與引號。

將這個 Javadoc 匯出的設定儲存成 Ant Script

儲存一個 Ant Script,以用來執行指定的 Javadoc 匯出,而不用到精靈。 您可使用這個精靈來修改現有的 Ant Script (從所產生之 Ant Script 上的快速功能表,使用「開啟 Javadoc」精靈)

在瀏覽器中開啟產生的索引檔 在瀏覽器中開啟所產生的 index.html 檔(只有在使用標準 doclet 時才能用到)

按下完成以開始產生 Javadoc。 如果目的地和專案之 「Javadoc 位置」頁面中所配置的位置不同, 則會詢問您是否要將專案的 Javadoc 位置設為新的目的地資料夾。 當如此做時,所有的「開啟外部 Javadoc」呼叫作業將會使用這時所建的文件。

會啟動新程序,並在背景下執行產生作業。 如果要查看產生作業的進度與狀態,請開啟「主控台」視圖 (「視窗」>「顯示視圖」>「主控台」)。

相關作業

建立 Javadoc 文件

相關參照

檔案動作
「Javadoc 位置」內容