1. 程式人生 > >IDEA 2017 生成javadoc檔案

IDEA 2017 生成javadoc檔案

話不多說,直接上步驟

1.開啟選單欄 Tools -> Generate JavaDoc
這裡寫圖片描述

2.點選上述選單項後,會出現生成 JavaDoc 的對話方塊,一般的選項都很直觀,不必細說。但是要注意生成 JavaDoc 的原始碼物件的選擇,一般以模組(Module)為主,必要時可以單獨選擇必要的 Java 原始碼檔案,不推薦以 Project 為 JavaDoc 生成的源範圍。
這裡寫圖片描述

3.裡面有一個 Locale 可選填項,表示的是需要生成的 JavaDoc 以何種語言版本展示,根據 javadoc.exe 的幫助說明,這其實對應的就是 javadoc.exe 的 -locale 引數,如果不填,預設可能是英文或者是當前作業系統的語言,既然是國人,建議在此填寫 zh_CN

,這樣生成的 JavaDoc 就是中文版本的,當然指的是 JavaDoc 的框架中各種通用的固定顯示區域都是中文的。你自己編寫的註釋轉換的內容還是根據你註釋的內容來。

4.還有一個“Other command line arguments:”可選填項,非常重要,是填寫直接向 javadoc.exe 傳遞的引數內容。因為有一些重要的設定,只能通過直接引數形式向 javadoc.exe 傳遞。這裡必須要填寫如下引數:

-encoding UTF-8 -charset UTF-8 -windowtitle “你的文件在瀏覽器視窗標題欄顯示的內容

解釋:
第一個引數 -encoding UTF-8

表示你的原始碼(含有符合 JavaDoc 標準的註釋)是基於 UTF-8 編碼的,以免處理過程中出現中文等非英語字元亂碼;

第二個引數 -charset UTF-8 表示在處理並生成 JavaDoc 超文字時使用的字符集也是以 UTF-8 為編碼,目前所有瀏覽器都支援 UTF-8,這樣最具有通用性,支援中文非常好;

第三個引數 -windowtitle 表示生成的 JavaDoc 超文字在瀏覽器中開啟時,瀏覽器視窗標題欄顯示的文字內容;

第四個引數 -link 很重要,它表示你生成的 JavaDoc 中涉及到很多對其他外部 Java 類的引用,是使用全限定名稱還是帶有超連結的短名稱,舉個例子,我建立了一個方法 public void func(String arg),這個方法在生成 JavaDoc 時如果不指定 -link 引數,則 JavaDoc 中對該方法的表述就會自動變為 public void func(java.lang.String arg),因為 String 這個類對我自己實現的類來講就是外部引用的類,雖然它是 Java 標準庫的類。如果指定了 -link

http://docs.oracle.com/javase/7/docs/api 引數,則 javadoc.exe 在生成 JavaDoc 時,會使用 String 這樣的短名稱而非全限定名稱 java.lang.String,同時自動為 String 短名稱生成一個超連結,指向官方 JavaSE 標準文件 http://docs.oracle.com/javase/7/docs/api 中對 String 類的詳細文件地址。-link 實質上是告訴 javadoc.exe 根據提供的外部引用類的 JavaDoc 地址去找一個叫 package-list 的文字檔案,在這個文字檔案中包含了所有外部引用類的全限定名稱,因此生成的新 JavaDoc 不必使用外部引用類的全限定名,只需要使用短名稱,同時可以自動建立指向其外部引用 JavaDoc 中的詳細文件超連結。每個 JavaDoc 都會在根目錄下有一個 package-list 檔案,包括我們自己生成的 JavaDoc。