Intellij IDEA如何生成JavaDoc？

2025-01-09 技术教程

javadoc基本介绍

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

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

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

那我们如何通过Intellij IDEA如何生成JavaDoc？

第一步：在工具栏中找到 Tool，然后再子菜单中找到 Generate JavaDoc。

第二步：在生成文档上进行配置。

配置的简单介绍：

参数说明

1.Whole project:整个项目都生成文档2.Custom scope 自定义范围。如下：（1）project files 项目文件，（2）project production files 项目产品文件，（3）project test files 项目的测试文件，未知范围，class hierarchy 类层3.include test source 包含测试目录4.include JDK and … 包含jdk和其他的第三方jar5.link to JDK documentation…链接到JDK api6.output directy 生成的文档存放的位置（1）private、package、protected、public 生成文档的级别（类和方法）（2）右边的Generate…是选择生成的文档包含的内容，层级树、导航、索引.. （3）再右边是生成的文档包含的内容信息，作者版本等信息7.Locale 语言类型,zh-CN8.Other command line arguments 其他参数9.Maximum heep… 最大堆栈