此精靈可讓您產生「Javadoc 產生」。 這是 javadoc.exe 工具的使用者介面,可在 Java JDK 中找到。 如需 Javadoc 工具的完整文件,請造訪 Sun's Javadoc Tool 網頁。
如果要執行此精靈,必須在 Javadoc 喜好設定頁面(「視窗」>「喜好設定」> Java > Javadoc)中配置一個 Javadoc 指令。
類型選項:
選項 |
說明 |
---|---|
選取要產生 Javadoc 的類型 |
在清單中,勾選或清除勾選框,以明確指定要匯出到 JAR 檔中的類型。 此清單會根據工作台中的選擇項來起始設定。 您一次只能選取一個專案,這是因為在執行 Javadoc 工具時, 一次只能使用一個專案的類別路徑。 |
為設有 visibility 的成員建立 Javadoc |
|
使用標準 doclet |
以標準 doclet 啟動 Javadoc 指令(預設值)
|
使用自訂 doclet |
使用自訂 doclet 來產生文件
|
標準 Doclet 引數(當選取了使用標準 doclet 時就可使用):
選項 |
說明 |
---|---|
文件標題 |
指定文件的標題。 |
產生「使用」頁面 | 如果您想讓文件中包含一個「使用」頁面,請選取此選項。 |
產生階層樹狀結構 | 如果您想讓文件中包含一個「樹狀結構」頁面,請選取此選項。 |
產生導覽器列 |
如果您想讓文件中包含一個導覽列(標頭與標底),請選取此選項。 |
產生索引 | 如果您想讓文件中包含一個「索引」頁面,請選取此選項。 |
每個字母各產生一個索引 | 每個字母各建一個索引。當選取了產生索引時,表示已啟用。 |
@author | 如果您想闡明 @author 標示,請選取此選項。 |
@version | 如果您想闡明 @version 標示,請選取此選項。 |
@deprecated | 如果您想闡明 @deprecated 標示,請選取此選項。 |
已停用的清單 | 如果您想讓文件中包含一個「已停用」頁面,請選取此選項。 當選取了 @deprecated 選項,就表示已啟用。 |
選取 Javadoc 應建立鏈結的參照類別 |
指出當有參照其它類型時,Javadoc 應建立和其它哪些文件的鏈結。
|
樣式表 | 選取所要使用的樣式表 |
一般 Javadoc 選項:
選項 |
說明 |
---|---|
總覽 |
指出 Javadoc 應從所提供的檔案中擷取總覽文件的文字。 將放在 overview-summary.html 檔中。 |
其它的 Javadoc 選項 |
在此新增其它選項(數量不限):自訂 doclet 選項、VM 選項、JRE 1.4 相容性選項等。
|
將此 Javadoc 匯出的設定儲存成 Ant Script |
儲存一個 Ant Script,以用來執行指定的 Javadoc 匯出,而不用到精靈。 您可使用此精靈來修改現有的 Ant Script (從所產生之 Ant Script 上的快速功能表,使用「開啟 Javadoc」精靈) |
在瀏覽器中開啟產生的索引檔 | 在瀏覽器中開啟所產生的 index.html 檔(只有在使用標準 doclet 時才能用到) |
按下完成以開始產生 Javadoc。 如果目的地和專案之 「Javadoc 位置」頁面中所配置的位置不同, 則會詢問您是否要將專案的 Javadoc 位置設為新的目的地資料夾。 當如此做時,所有的「開啟外部 Javadoc」呼叫作業將會使用此時所建的文件。
會啟動新程序,並在背景下執行產生作業。 如果要查看產生作業的進度與狀態,請開啟「主控台」檢視畫面 (「視窗」>「顯示檢視畫面」>「主控台」)。