11-IDEA-生成Javadoc外部文档

  1. IDEA中，点击 Tools-> Generate JavaDoc，这样会打开生成 javadoc 文档的配置页面。

  2. 进行配置：

image-20210217182039521

标注的是重要的部分，从上往下分别是配置 javadoc 的范围，输出文件夹路径以及命令行参数。

这里的命令行参数很重要，因为只有使用 utf-8 编码才能保证生成时可以正常处理中文字符，所以一定要加上：

1
-encoding utf-8 -charset utf-8

还可以配置那些注解需要生成，哪些权限类（private、package、protected、public）需要生成等等精细的控制。

还有一点需要注意，即不要勾选“Include test sources”，勾选后，生成时会造成很奇怪的错误。

  1. 配置好后，点击生成按钮，生成好后就会自动在浏览器打开进行查看:

image-20210217182124296

00_先利其器 > 01_Intellij IDEA
#IDEA #javadoc #文档
11-IDEA-生成Javadoc外部文档
https://janycode.github.io/2021/02/17/00_先利其器/01_Intellij IDEA/11-IDEA-生成Javadoc外部文档/
作者
Jerry(姜源)
发布于
2021年2月17日
许可协议