?2016-2026 Matools All rights reserved,
粵ICP備17059708號
在進行項目開發(fā)過程中，項目接口文檔是很重要的一塊內容，在java項目中我們可以用swagger，asciidoc，javadoc等方式來生產(chǎn)文檔，而其中最基本的文檔生成方式就是javadoc，它一般用在離線文檔的生成上，我們需要按排它的規(guī)定來書寫注釋，從而最終生成文檔。
標準化注釋
* @link：{@link 包名.類名#方法名(參數(shù)類型)} 用于快速鏈接到相關代碼
* @code： {@code text} 將文本標記為code
* @param：一般類中支持泛型時會通過@param來解釋泛型的類型
* @author：作者信息
* @see ：另請參閱，其它備注
* @since ：從以下版本開始
* @version：當前版本號
* @param：后面跟參數(shù)名，再跟參數(shù)描述
* @return：返回值
* @throws ：跟異常類型 異常描述 , 用于描述方法內部可能拋出的異常跟返回值的描述
* @exception：用于描述方法簽名throws對應的異常
* @see：既可以用來類上也可以用在方法上，表示可以參考的類或者方法
* @value：用于標注在常量上，{@value} 用于表示常量的值
* @inheritDoc：用于注解在重寫方法或者子類上，用于繼承父類中的Javadoc
生成doc文件
工具＝生成doc （tools=generate javaDocs...）
* 如果是中文注釋，需要注意幾點
* locale：設置成zh_CN
* other command line arguments 設置成-encoding UTF-8 -charset UTF-8
熱門工具 換一換