IntelliJIDEA中如何使用JavaDoc

　　IntelliJ IDEA 12.1.6，自己提供了很好的 JavaDoc 生成功能，以及標準 JavaDoc 註釋轉換功能，其實質是在代碼編寫過程當中，按照標準 JavaDoc 的註釋要求，爲須要暴露給使用者的類、方法以及其餘成員編寫註釋。而後使用 IDEA 的功能自動調用 javadoc.exe（JDK 自帶的工具）根據源代碼中的註釋內容自動生成 JavaDoc 文檔（超文本格式）。這裏有幾點卻是要特別注意一下：

 

1. IDEA 的 JavaDoc 生成功能在菜單 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 "你的文檔在瀏覽器窗口標題欄顯示的內容" -link http://docs.Oracle.com/javase/7/docs/api

    

5. 第一個參數 -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。

　　JavaDoc 生成完畢，便可在其根目錄下找到 index.html 文件，打開它就能夠看到咱們本身的標準 JavaDoc API 文檔啦。