jdk工具javadoc有什么用

发布时间:2020-10-29 09:44:34 作者:小新
来源:亿速云 阅读:188

这篇文章主要介绍jdk工具javadoc有什么用,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!

jdk工具javadoc的作用是“生成Java文档”;javadoc是Java文档生成器,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。

jdk工具javadoc的作用是“生成Java文档”。

javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。

javadoc命令是用来生成自己API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java。

常用标记

标签说明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}几个不常用的标签,由于不常使用,我们不展开叙述,感兴趣的读者可以查看帮助文档。

以上是jdk工具javadoc有什么用的所有内容,感谢各位的阅读!希望分享的内容对大家有帮助,更多相关知识,欢迎关注亿速云行业资讯频道!

推荐阅读:
  1. jdk工具有哪些
  2. JavaDoc怎么用

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

javajdk javadoc ava

上一篇:如何解决mysql导入文件中文乱码的问题

下一篇:php+redis实现对200w用户即时推送服务的案例

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》