通过IDEA，来生成Javadoc文档

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

在编写完文档注释和代码之后,进行如下操作:

在IDEA中点击 Tools > Generate javadoc:

进入：

解释说明:
Whole project:整个项目都生成文档
Custom scope: 自定义范围。
include JDK and … : 包含jdk和其他的第三方jar
link to JDK documentation…: 链接到JDK api
output directy :生成的文档存放的位置
private、package、protected、public :生成文档的级别（类和方法）
Generate…:是选择生成的文档包含的内容，层级树、导航、索引…
Generate右边的@:是生成的文档包含的内容信息，作者版本等信息
Locale :语言类型,zh-CN 或者不填
Other command line arguments: 其他参数
Maximum heep… :最大堆栈

建议使用UTF-8编码、否则会出现中文乱码: -encoding UTF-8 -charset UTF-8

写在类上面的Javadoc:

写在类上的文档标注一般分为三段：

第一段：概要描述，通常用一句或者一段话简要描述该类的作用，以英文句号作为结束
第二段：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都以英文句号作为结束
第三段：文档标注，用于标注作者、创建时间、参阅类等信息

写在方法上的Javadoc:

写在方法上的文档标注一般分为三段：

第一段：概要描述，通常用一句或者一段话简要描述该方法的作用，以英文句号作为结束
第二段：详细描述，通常用一段或者多段话来详细描述该方法的作用，一般每段话都以英文句号作为结束
第三段：文档标注，用于标注参数、返回值、异常、参阅等

点击ok进行开始打包javadoc：

可以看到打包成功:

打开index.html之后就是文档界面了:

————————————————