文档注释
文档注释
javadoc 标签
javadoc 工具软件识别以下标签:
| 标签 | 描述 |
|---|---|
@param | 说明一个方法的参数 |
@return | 说明返回值类型 |
@version | 指定类的版本 |
@author | 标记文档的作者 |
@version | 标记文档的版本 |
@since | 标记文档的版本 |
@deprecated | 指名一个过期的类或成员 |
{@docRoot} | 指明当前文档根目录的路径 |
@exception | 标志一个类抛出的异常 |
{@inheritDoc} | 从直接父类继承的注释 |
{@link} | 创建一个链接 |
{@linkplain} | 创建一个链接,不使用 |