javadoc命令生成个人API文档

JDK1.8（即JDK8）的API文档页面如下：

官方文档链接：https://docs.oracle.com/javase/8/docs/api/

如果我们想给自己写的类也建立相同格式的文档，就需要用到javadoc了。

1，javadoc书写

建立的类和方法如上图，我们可以为类 Hello 添加 javadoc 注释，也可以为方法 getString() 单独添加javadoc注释。
为类添加javadoc注释，在类的上方输入“/**”后回车，IDEA将自动补全其余部分，如下图。

我们可以在注释内书写该类的参数信息，比如作者、版本号等。具体可书写内容如下图：

2，生成API文档

(1)命令行生成

在命令行中进入类所在的文件夹中，在命令行输入如下格式的命令：

这里的“-encoding utf-8”和“-charset utf-8”是为了防止识别中文时出现乱码，“Hello.java”就是要生成文档的类。
回车后出现如下信息：

此时类所在的文件夹中出现了一些新的文件：

打开 index.html，就是生成的API文档了。

(2)IDEA生成

也可以直接使用IDEA来生成API文档。选择“Tools”中的“Generate JavaDoc…”。

如下图，Output directory用来选择文档的存储位置，红圈圈起来的地方是设置中文编码。设置完后点击“OK”，指定的存储位置里就会产生 index.html 及其他文件。