java常用注释注解

1.@author

用于表示创建编辑这个类或者方法的作者。

用法：@author Rex表明作者是Rex

2.@see

其指向包、类、方法、属性，可以在注释中实现链接跳转。

用法：@see package.class#member，如果跳转同一个类中就@see #member即可，同一个包中就@see class#member

3.@since

标明一个类，方法，或其它标识符是在哪个特定版本开始添加进来的。

用法：@since 1.0表明1.0版本添加进来的

4.@return

用于描述返回信息，返回的内容，返回的数据形式。

用法：@return 返回信息描述

5.@param

传入的参数的类型，信息，功能。

用法：@param parameterName description表明parameterName参数的类型，信息或者功能是description

6.@throws / @exception

用于描述抛出异常的类型，信息，功能。

7.@version

用于描述版本号。

8.{@link}

插入一个到另一个主题的链接{@link name text}

用法：{@link package.class#member}，如果跳转同一个类中就{@link #member}即可，同一个包中就{@link class#member}

9.{@linkplain}

插入一个到另一个主题的链接，但是该链接显示纯文本字体.类似于 @link

10{@docRoot}

指明当前文档根目录的路径Directory Path

11.{@inheritDoc}

从直接父类继承的注释.

12.@serial

说明一个序列化属性@serial description

13.@serialData

说明通过writeObject( ) 和 writeExternal( )方法写的数据@serialData description

14.@serialField

说明一个ObjectStreamField组件@serialField name type description

15.{@value}

显示常量的值，该常量必须是static属性。

16.@deprecated

指名一个过期的类或成员@deprecated description