— 標籤
@param
@param 空格後面跟上形參(不是資料型別)空格後跟著對該引數的描述。
在描述中第一個名字為該變數的資料型別
對於引數的描述是一個句子,最好不要首字母大寫,
如果出現了句號這說明你的描述不止一句話。如果非要首字母大寫的話,必須用句號來結束句子。(英文的句號)
Ref 描述語句(沒有@)
@return 標記
返回為空(void)的建構函式或者函式,@return可以省略。
如果返回值就是輸入引數,必須用與輸入引數的@param相同的描述資訊。
@throws 標記
@throws以前使用的是@exception。
@throws的內容必須在函式的throws部分定義(在方法中定義的部分 如throws nullpiontexception)
@author標記
類註釋標記。
函式註釋裡面可以不出現@author。
@version 釋標記。
函式註釋裡面可以不出現@version
@since
類註釋標記。
標明該類可以執行的JDK版本
標記順序
3 註釋塊標記
3.1 標記的順序
塊標記將採用如下順序:
…
*
* @param (classes, interfaces, methods and constructors only)
* @return (methods only)
* @exception (@throws is a synonym added in Javadoc 1.2)
* @author (classes and interfaces only, required)
* @version (classes and interfaces only, required. See footnote 1)
* @see
* @since
* @serial (or @serialField or @serialData)
* @deprecated (see How and When To Deprecate APIs)
* …
一個塊標記可以根據需要重複出現多次,多次出現的標記按照如下順序:
@author 按照時間先後順序(chronological)
@param 按照引數定義順序(declaration)
@throws 按照異常名字的字母順序(alphabetically)
@see 按照如下順序:
@see #field
@see #Constructor(Type, Type...)
@see #Constructor(Type id, Type id...)
@see #method(Type, Type,...)
@see #method(Type id, Type, id...)
@see Class
@see Class#field
@see Class#Constructor(Type, Type...)
@see Class#Constructor(Type id, Type id)
@see Class#method(Type, Type,...)
@see Class#method(Type id, Type id,...)
@see package.Class
@see package.Class#field
@see package.Class#Constructor(Type, Type...)
@see package.Class#Constructor(Type id, Type id)
@see package.Class#method(Type, Type,...)
@see package.Class#method(Type id, Type, id)
@see package 3 註釋塊標記
ecilipse 自動生成文件 請參照連線 http://jingyan.baidu.com/article/597a0643485c11312b5243c7.html