一、Javadoc的基本信息：
javadoc是Sun公司提供的一個技術，它從程序源代碼中抽取類、方法、成員等注釋形成一個和源代碼配套的API幫助文檔。也就是說，只要在編寫程序時以一套特定的標簽作注釋，在程序編寫完成后，通過Javadoc就可以同時形成程序的開發文檔了。javadoc命令是用來生成自己API文檔的，使用方式：使用命令行在目標文件所在目錄輸入javadoc +文件名.java。
Javadoc主要用於代碼的注釋規范性。
二、Javadoc的基本用法
1.1主要講述寫在類上面的Javadoc用法
寫在類上的文檔標注一般分為三段：
- 第一段：概要描述，通常用一句或者一段話簡要描述該類的作用，以英文句號作為結束
- 第二段：詳細描述，通常用一段或者多段話來詳細描述該類的作用，一般每段話都以英文句號作為結束
- 第三段：文檔標注，用於標注作者、創建時間、參閱類等信息
在注釋中出現以@開頭東東被稱之為Javadoc文檔標記，是JDK定義好的，如@author、@version、@since、@see、@link、@code、@param、@return、@exception、@throws等。
主要的文檔標記
1. @link：{@link 包名.類名#方法名(參數類型)} 用於快速鏈接到相關代碼
@link的使用語法{@link 包名.類名#方法名(參數類型)}，其中當包名在當前類中已經導入了包名可以省略，可以只是一個類名，也可以是僅僅是一個方法名，也可以是類名.方法名，使用此文檔標記的類或者方法，可用通過按住Ctrl鍵+單擊 可以快速跳到相應的類或者方法上，解析成html其實就是使用< code> 包名.類名#方法名(參數類型)< /code>
2. @code： {@code text} 將文本標記為code
{@code text} 會被解析成<code> text </code>
將文本標記為代碼樣式的文本，在code內部可以使用 < 、> 等不會被解釋成html標簽, code標簽有自己的樣式
一般在Javadoc中只要涉及到類名或者方法名，都需要使用@code進行標記。
3. @param
一般類中支持泛型時會通過@param來解釋泛型的類型
4. @author
詳細描述后面一般使用@author來標記作者，如果一個文件有多個作者來維護就標記多個@author，@author 后面可以跟作者姓名(也可以附帶郵箱地址)、組織名稱(也可以附帶組織官網地址)
5. @see
@see 一般用於標記該類相關聯的類,@see即可以用在類上，也可以用在方法上。
6. @since 從以下版本開始
@since 一般用於標記文件創建時項目當時對應的版本，一般后面跟版本號，也可以跟是一個時間，表示文件當前創建的時間
7. @version 版本
@version 用於標記當前版本，默認為1.0
8. @param
@param 后面跟參數名，再跟參數描述
9. @return
@return 跟返回值的描述
10. @value
用於標注在常量上，{@value} 用於表示常量的值
1）概要描述：通常用一句或者一段話簡要描述該類的作用， 如：
2）詳細描述 ------ 詳細描述和概要描述要求要空一行
詳細描述一般用一段或者幾個鍛煉來詳細描述類的作用，詳細描述中可以使用html標簽，如<p>、<pre>、<a>、<ul>、<i>等標簽， 通常詳細描述都以段落p標簽開始。<a>一般用於標注出現的組織的鏈接
1.2 javadoc寫在方法上的文檔標注一般分為三段：
- 第一段：概要描述，通常用一句或者一段話簡要描述該方法的作用，以英文句號作為結束
- 第二段：詳細描述，通常用一段或者多段話來詳細描述該方法的作用，一般每段話都以英文句號作為結束
- 第三段：文檔標注，用於標注參數、返回值、異常、參閱等