我用过的 javadoc

看了一些代码，经常背地里骂他们不写注释（其实我也不怎么写），前段时间看了另外一些工程的代码，注释不多，但已经好多了，而且感觉挺规范的（该有注释的地方有，而且用了一些javadoc），所以自己决定，以后也要写些注释并且要加上javadoc的注解，学习………………，下面是我用的一些注解和部分理解，与java规范无关，主要是我的习惯，仅供参考，也欢迎大家批评指正。

 

1. @author 
这个好理解，作者信息，这个可以用多个@author

例：/**

 * 
 * @author test
 * @author [e-mail]
 * @Date 2011-12-19
 * @version 1.0
 */

 

2.@Date 

日期

3. @version

版本，每个类或接口最多有一个

4.@since

功能模块从啥时候开始有的

5.{@link } 

链接相关的类或者方法，我觉得主要是这个类或者方法中调用的

6.@see

参考的其他类或者方法，这个类的相关类或者父类、子类什么的，会出现在doc中的参见项中。例：DateFormat 的注解。

* @see Format

 * @see          NumberFormat
 * @see          SimpleDateFormat
 * @see          java.util.Calendar
 * @see          java.util.GregorianCalendar
 * @see          java.util.TimeZone

public abstract class DateFormat extends Format

 

7. {@value}

用来显示静态字段的值。例：

/**

 * The value of this constant is {@value}
 **/
public static final String SCRIPT_START = "script";

 

鼠标移动到SCRIPT_START 上面后出现：

The value of this constant is "script"

 

8.