IDEA生成Java Doc帮助文档

使用场景

使用IDEA（本次使用2020.3版）将自己写的常用的工具类打成jar包，安装到maven本地仓库，最后生成对应的doc参考文档。

操作流程

方法一

选中项目 右键 show in Explor，如下图：

选中地址栏 cmd

输入命令 javadoc -encoding UTF-8 -charset UTF-8 xxx.java

最终会在目录下生成一些html静态文件说明生成成功。

方法二

使用idea生成

1. （选中要生成文档的类或者源码包）找到工具栏tools --> Gencrate JavaDoc...打开, 如下图：

2. 在弹出的窗口主要进行三步

第一步：包所在目录，如果已选中 这里不用选择；

第二步：输入要输出文件的地址，及帮助文档输出地址；

第三步：输入语言环境为中文：zh_CN

第四步：输入命令行参数: -encoding UTF-8 -charset UTF-8

3. 点击ok（生成成功）完成后如下图：