您的足迹:首页 > 未分类 >javadoc 和 javadoc注释规范

javadoc 和 javadoc注释规范

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

此 外还有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、 {@code} {@value arg}几个不常用的标签,由于不常使用,我们展开叙述,感兴趣的读者可以查看帮助文档。


本博客所有文章如无特别注明均为原创。作者:admin
版权所有:《电光石火》 => javadoc 和 javadoc注释规范
本文地址:http://www.ilkhome.cn/?post=442
欢迎转载!复制或转载请以超链接形式注明,文章为 admin 原创,并注明原文地址 javadoc 和 javadoc注释规范,谢谢。

相关推荐

版权所有:《电光石火》 => javadoc 和 javadoc注释规范
本文地址:http://www.ilkhome.cn/?post=442
欢迎转载!请注明,文章均为 《电光石火》 原创,并注明本文地址,谢谢。


发表评论

路人甲 表情
看不清楚?点图切换 Ctrl+Enter快速提交

网友评论(0)