javadoc的使用

在進行項目開發過程當中，項目接口文檔是很重要的一塊內容，在java項目中咱們能夠用swagger，asciidoc，javadoc等方式來生產文檔，而其中最基本的文檔生成方式就是javadoc，它通常用在離線文檔的生成上，咱們須要按排它的規定來書寫註釋，從而最終生成文檔。

標準化註釋

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