一、簡介

• JavaDoc是一種將註釋生成HTML文件的技術，它從程式原始碼中抽取類、方法、成員等註釋形成一個和原始碼配套的API幫助文件。
• 也就是說，只要在編寫程式時以一套特定的標籤作註釋，在程式編寫完成後，通過Javadoc就可以同時形成程式的開發文件了。

二、註釋標籤

常用標籤列表：

1. 作者：@author
2. 版本號：@version
3. 需要使用的JDK最早版本：@since
4. 引數：@param
5. 返回值：@return
6. 丟擲的異常：@throws

注意：

• 註釋標籤必須在JavaDoc註釋中使用。
• JavaDoc註釋可以用在類、變數和方法上。
• JavaDoc註釋在開始的'/**'之後，第一行或幾行是關於類、變數和方法的主要描述
  。
• 之後，你可以包含一個或多個各種各樣的註釋標籤。每一個註釋標籤必須在一個新行的開始,或者在一行的開始緊跟星號後面。
• 多個相同型別的標籤應該放成一組。例如，如果你有三個'@param'標籤，可以將它們一行接一行的放在一起。

示例：

/**
 * 這是一個方法
 *
 * @author conyoo
 * @version 1.0
 * @since 1.8
 * @param parameter 一個引數
 * @return 一個返回值
 * @throws Exception 一個異常
 */
public String test(String parameter) throws Exception {
    return parameter;
}
 

三、javadoc命令

• 開發者可以在命令列中使用'javadoc'命令，來生成JavaDoc文件。
• 'javadoc'命令既可以處理包，也可以處理java原始檔。

語法：javadoc [options] [packagenames] [sourcefiles] [@files]

注意：

• 設定編碼引數'-encoding'和字符集引數'-charset'為'UTF-8'，可以解決中文亂碼問題。
• 'javadoc'命令不遞迴作用於子包，所以處理包時不允許對包名使用萬用字元，必須列出希望建立文件的每一個包。
• '[@files]'：為了簡化javadoc命令，你可以把需要建立文件的檔名和包名放在一個或多個文字檔案中。

示例：

D:\workspace\demo\src\com\cnblogs\www\example>javadoc -encoding UTF-8 -charset UTF-8 HelloWorld.java