java文檔註釋
阿新 • • 發佈:2019-03-19
ember 完整 參數 lin string style 文檔 方法 內容
- 語法
所有javadoc命令都只能在 “/**註釋內容 */”註釋出現
- 方式
- 嵌入HTML或叫文檔標簽
- 行內文檔標簽
一般都以“@”字符開頭
- 類型
3.1:共有三種類型:類,域,方法(都定義類型之前)
- 以“@”開頭的標簽
(1) @see:標簽允許用戶引用其他類的文檔,java會在生成的HTML文件中,設置超鏈接到其他文檔。格式如下:
@see 類名
@see 完整類名(例如:java.lang.String)
@see 完整類名#方法名(例
如:java.lang.String#toString)
(2) @link :插入一個到另一個主題的鏈接
{@link package.class#member laber}
(3) {@docRoot} :指明當前文檔根目錄的路徑
(4) {@inheritDoc}:從直接父類繼承的註釋
(5) @version : 類的版本
(6) @author:作者
(7) @since :指定所用的JDK版本的情況
(8) @param :指定方法的參數
(9) @return :返回值
(10) @throws : 指定拋出異常
(11) @Deprecated :標識一個類的作者
一般來說在編程中常用的是:@author,@param,@retrun,@throws,@version
java文檔註釋