Java中常用注释标签

242 阅读1分钟
标签用途说明
@author name类/接口描述代码的作者,每个作者对应一个标签。
@Description类/接口/方法对类,方法,接口的简单描述
@deprecated类/成员方法说明该API已经废除。
@exception name description 或 @throws name description成员方法描述方法抛出的异常,每一个异常对应一个标签
@param name description成员方法描述成员方法中参数用途和意义,一个参数对应一个标签
@return description成员方法描述成员方法的返回值的意义
@since类/接口/成员方法描述该API最初出现时间,可以填写版本号
@see ClassName类/接口/成员方法/成员变量用于引用特定的类的成员方法的描述,参考转向,一般ClassName是包括包名的全名
@data类/接口/方法用于显示类,方法,接口具体创建时间,或者修改时间
@version text类/接口版本
@inheritDoc类/接口/成员方法继承的文档
{@link address} 或者 @ linkplain address text}类/接口/方法用于创建一个指向另一份文档的超链接