jdk工具中的javadoc作用是什么呢？

时间2024-03-27 17:38:03发布访客分类其他后端知识浏览570

导读：这篇文章给大家分享的是“分析jdk工具中的javadoc作用是什么呢？”，文中的讲解内容简单清晰，对大家学习和理解有一定的参考价值和帮助，有这方面学习需要的朋友，接下来就跟随小编一起学习一下“分析jdk工具中的javadoc作用是什么呢？”...

这篇文章给大家分享的是“分析jdk工具中的javadoc作用是什么呢？”，文中的讲解内容简单清晰，对大家学习和理解有一定的参考价值和帮助，有这方面学习需要的朋友，接下来就跟随小编一起学习一下“分析jdk工具中的javadoc作用是什么呢？”吧。

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

相关推荐：《Java视频教程》

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作用是什么呢？”的介绍了，感谢各位的阅读，希望文本对大家有所帮助。如果想要了解更多知识，欢迎关注网络，小编每天都会为大家更新不同的知识。

声明：本文内容由网友自发贡献，本站不承担相应法律责任。对本内容有异议或投诉，请联系2913721942#qq.com核实处理，我们将尽快回复您，谢谢合作！