概述

      在大型專案中不免會有很多對外暴露的方法與介面，那我們就需要在類或者方法上面按照JavaDoc標準編寫註釋，就比如這樣：

      前面我們也提到過在Idea中可以將滑鼠停留在方法名上，然後點選F2檢視方法的說明，這個說明就是程式設計師編寫的JavaDoc

      那我們如何將一個專案中自己編寫的JavaDoc生成一個HTML格式的文件呢？

      IDEA提供了這個工具，其底層還是 IDEA呼叫 javadoc.exe（JDK 自帶的工具）根據原始碼中的註釋內容自動生成 JavaDoc 文件（超文字格式）。

生成步驟

第一步：開啟“生成JavaDoc”對話方塊

第二步：配置引數

       1.一號位置是用於選擇JavaDoc的生成範圍，這裡我們指定的是當前的Module，如果有需求的話也可以指定特定檔案

       2.二號位置用於指定文件生成後的輸出位置

       3.三號位置用於指定需要生成的JavaDoc的以何種語言展示。根據 javadoc.exe 的幫助說明，這其實對應的就是 javadoc.exe 的 -locale 引數，如果不填，預設可能是英文或者是當前

       4.四號位置用於填寫需要傳入的引數（非常重要）

          這裡填寫如下引數：

-encoding UTF-8 -charset UTF-8 -windowtitle "你的文件在瀏覽器視窗標題欄顯示的內容" -link http://docs.Oracle

引數說明：

第一個引數： -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。

點選OK後控制檯輸出下面內容

檢視生成的文件

本文章轉載至https://www.cnblogs.com/xiaoming0601/p/6657136.html，感謝“小明快點跑”博主對我的幫助。