在(zai)進行項(xiang)目(mu)開(kai)發過程中(zhong)，項(xiang)目(mu)接口文(wen)檔是很重要(yao)的一塊內容(rong)，在(zai)java項(xiang)目(mu)中(zhong)我們可以用swagger，asciidoc，javadoc等(deng)方(fang)式來(lai)(lai)生產文(wen)檔，而其中(zhong)最(zui)(zui)基本的文(wen)檔生成方(fang)式就是javadoc，它一般用在(zai)離線文(wen)檔的生成上，我們需要(yao)按排它的規定來(lai)(lai)書寫注釋(shi)，從而最(zui)(zui)終(zhong)生成文(wen)檔。

標準化注釋

1. @link：{@link 包名.類名#方法名(參數類型)} 用于快速鏈接到相關代碼
2. @code： {@code text} 將文本標記為code
3. @param：一般類中支持泛型時會通過@param來解釋泛型的類型
4. @author：作者信息
5. @see ：另請參閱，其它備注
6. @since ：從以下版本開始
7. @version：當前版本號
8. @param：后面跟參數名，再跟參數描述
9. @return：返回值
10. @throws ：跟異常類型 異常描述 , 用于描述方法內部可能拋出的異常跟返回值的描述
11. @exception：用于描述方法簽名throws對應的異常
12. @see：既可以用來類上也可以用在方法上，表示可以參考的類或者方法
13. @value：用于標注在常量上，{@value} 用于表示常量的值
14. @inheritDoc：用于注解在重寫方法或者子類上，用于繼承父類中的Javadoc

生成doc文件

工具->生成doc （tools->generate javaDocs...）

• 如果是中文注釋，需要注意幾點

1. locale：設置成zh_CN
2. other command line arguments 設置成-encoding UTF-8 -charset UTF-8
   

生成后的index.html文件