javadoc 常用变量

づ嗳嘚亽鈊↑

不同版本的JDK所支持的Javadoc标签是不一样的，此外还可以按标签适用的地方分成不同类型，如只适用于方法的@return标签，我们称之为方法标签，只适用于变量的@serial标签，我们称之为值域标签，以此类推。往往一个标签适用于多种地方，下表对常用Javadoc标签进行说明：

　　表 2?1 javadoc标签说明

标签说明JDK 1.1 doclet标准doclet标签类型
@author 作者作者标识√√包、 类、接口
@version 版本号版本号√√包、 类、接口
@param 参数名 描述方法的入参名及描述信息，如入参有特别要求，可在此注释。√√构造函数、 方法
@return 描述对函数返回值的注释√√方法
@deprecated 过期文本标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API。√√包、类、接口、值域、构造函数、 方法
@throws异常类名构造函数或方法所会抛出的异常。√构造函数、 方法
@exception 异常类名同@throws。√√构造函数、 方法
@see 引用查看相关内容，如类、方法、变量等。√√包、类、接口、值域、构造函数、 方法
@since 描述文本API在什么程序的什么版本后开发支持。√√包、类、接口、值域、构造函数、 方法
{@link包.类#成员 标签}链接到某个特定的成员对应的文档中。√包、类、接口、值域、构造函数、 方法
{@value}当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。√(JDK1.4)静态值域