jdk工具javadoc的作用是什么?

  • 来源:网络
  • 更新日期:2020-10-28

摘要:jdk工具javadoc的作用是“生成Java文档”;javadoc是Java文档生成器,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。相关推荐:《Java视频教程》

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

更多编程相关知识,请访问:编程入门!!