Javadoc 标签用法
Javadoc 只输出类注释中以/**开始,以*/结束的内容,并且只输出public、protected权限的,对于private如果要输出可以使用-private;/** */里面的内容可以任意填写,而且你可以像写Html一样的去写注释,以便有更好的展示效果。
另外,javadoc还支持标签,下面是他们的一些用法:
@see : 引用其他类
格式:
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#method-name
{@link package.class#member label}
类似@see,不同的是他使用label作为超链接的文本,而不是“See Also”
{@docRoot}
链接到文档根目录的相对路径
{@inheritDoc}
从最直接的基类中继承相关文档到当前文档注释中
@version
指定版本信息
@author
指定作者信息
@since
指定code最早使用的JDK版本或是日期之类的信息
@param
格式:
@param parameter-name description
对指定的parameter-name进行说明
@return
说明返回值的含义
@throws
说明可能会抛出的异常信息
@deprecated或@Desprecated
说明方法已被新的方法或特性所替代,不建议使用
发表评论
| Trackback
