Java 生成Doc文档的全面解析及异常解决

简单上手：
菜单Tools-Generate JavaDoc，选择Whole project，Output directory选择文档生成的目录，Other command line arguments输入-encoding utf-8 -charset utf-8。点击OK即可生成。

报：
Error running 'Javadoc': At the moment, IDEA cannot generate Javadoc for multiple modules with module-info.java files in them. Sorry. We're working on this.
此报错在有module-info.java的多模块工程时产生。官方至2019.1.1专业版仍未能解决，只能删除各moudle的module-info.java暂时解决。

报：
Error running 'Javadoc': Selected scope contain no Java classes
选择的目录中无Java类文件

Generate JavaDoc界面选择：
1.Whole project:整个项目都生成文档
2.Custom scope 自定义范围。如下：
（1）project files 项目文件，
（2）project production files 项目产品文件，
（3）project test files 项目的测试文件，
（4）Scratches and Console 临时文件和控制台，参考：https://blog.csdn.net/haoranhaoshi/article/details/102802561
（5）Open files打开的文件
（6）Moudule '' 单个模块
（7）Current file当前文件
3.include test source 包含测试目录
4.include JDK and … 包含jdk和其他的第三方jar
5.link to JDK documentation…链接到JDK api
6.output directy 生成的文档存放的位置
（1）private、package、protected、public 生成文档的级别（类和方法）
（2）右边的Generate…是选择生成的文档包含的内容，层级树、导航、索引..
（3）再右边是生成的文档包含的内容信息，作者版本等信息
7.Locale 语言类型,zh-CN
8.Other command line arguments 其他参数
9.Maximum heep… 最大堆栈

高阶详解：
（1）IDEA的JavaDoc依靠JDK的javadoc.exe工具。
（2）local设置JavaDoc的语言版本，默认当前操作系统的语言，输入zh_CN表示中国。
（3）-encoding UTF-8表示源代码（含有符合 JavaDoc 标准的注释）是基于 UTF-8 编码的，以免处理过程中出现中文等非英语字符乱码。
（4）-charset UTF-8表示在处理并生成JavaDoc超文本时使用的字符集也是以 UTF-8 为编码，目前所有浏览器都支持 UTF-8，这样最具有通用性，支持中文非常好。
（5）-windowtitle 表示生成的 JavaDoc 超文本在浏览器中打开时，浏览器窗口标题栏显示的文字内容
（6）-link http://docs.oracle.com/javase/7/docs/api使javadoc.exe 在生成 JavaDoc 时，会使用 String 这样的短名称而非全限定名称 java.lang.String，同时自动为 String 短名称生成一个超链接，指向官方 JavaSE 标准文档 http://docs.oracle.com/javase/7/docs/api 中对 String 类的详细文档地址。-link 实质上是告诉 javadoc.exe 根据提供的外部引用类的 JavaDoc 地址去找一个叫 package-list 的文本文件，在这个文本文件中包含了所有外部引用类的全限定名称。如果你的源码用的是JDK8，对应https://docs.oracle.com/javase/8/docs/api/；如果是9对应https://docs.oracle.com/javase/9/docs/api/overview-summary.html。
（7）Ctrl+单击可选中左侧导航的多个模块，然后再点击菜单Tools-Generate JavaDoc，此时选择Selected files会对应你选中的那些模块文件。