ecilipse Javadoc文档注释

— 标签

@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