java注释文档
一些常用的javadoc标签
@see: other-class |
引用other-class 生成的html文档会有一个See Alse 作为超链接的只是条目 |
{@link package.class#member label} |
同@see, 但是用于行内. 生成的html文档会有一个label作为超链接的只是条目 |
{@docRoot} |
产生到文档根目录的相对路径,用于文档树页面的显示超链接 |
{@inheritDoc} |
从当前这个类的最直接的基类中继承相关文档到当前的文档注释中 |
@version version-information |
用于生成自定义的版本信息(version-information) |
@author author-information |
用于生成自定义的作者信息(author-information) |
@since |
指定程序代码最早使用的版本 |
@param parameter-name description |
parameter-name为方法参数列表的标识符, description表示可延续多行 |
@return return-value description |
return-value描述返回值的含义description表示可延续多行 |
@throws fully-qualified-class-name description |
fully-qualified-class-name给出一个在别处定义的异常类名字(不能产生歧义), description表示可延续多行 |
@Deprecated |
建议用户不使用的旧特性 |