標籤：字元 bsp cto 程式 ret auth 其他 title nbsp
文檔注釋是用於產生API文檔，API主要用於說明類、方法、成員變數
- javadoc工具 處理文檔源檔案在類、介面、方法、成員變數、構造器和內部類之前的注釋，忽略其他地方的文檔注釋。而且javadoc工具預設只處理以public或protected修飾的類、介面、方法、成員變數、構造器和內部類之前的文檔注釋。
- 如果開發人員希望javadoc工具可以提取private修飾的內容，則可以使用javadoc工具是增加-private選項
javadoc命令的基本用法如下：
javadoc 選項 Java源檔案|包
java源檔案可以支援萬用字元：
如，使用*.java來代表當前路徑下所有的java源檔案。
javadoc 的常用選項：
- -d<directory>: 該選項指定一個路徑，用於產生的API文檔存放到的指定目錄下。
- -windowtitle<text>: 該選項指定一個字串，用於設定API文檔的瀏覽器視窗標題。
- -doctitle<html-code>:該選項指定一個HTML格式文本，用於指定概觀頁面的標題。 只有處於當個包下的源檔案來產生API文檔時，才有概觀頁面。
- -header<html-code>:該選項指定一個HTML格式的文本，包含麼個頁面的頁首。
javadoc -d apidoc -windowtitle 測試 -doctitle 學習 javadoc 工具的測試 API 文檔 -header 我的類*Test.java
javadoc標記：
- @author: 指定Java程式的作者。
- @version:指定源檔案的版本。
- @deprecated:不推薦使用的方法。
- @param: 方法的參數說明。
- @return: 方法的傳回值說明資訊。
- @see: "參見“，用於指定交叉參考的內容。
- @exception: 拋出的異常的類型。
- @throws: 拋出的異常，和@exception同義。
上面的標記的使用有位置限制的。
出現在類或者介面文檔注釋中的有@see、@deprecated、@author、@version等
可以出現在方法或者構造器文檔注釋的有@see、@deprecated、@param、@return、@throws、和@exception等
可以出現在成員變數的文檔注釋中的有@see和@deprecated等
Java文檔注釋
