IntelliJ IDEA中生成javadoc

IntelliJ IDEA中生成javadoc

IntelliJ IDEA提供了一个实用程序，使您可以为项目生成Javadoc参考。

1. 从主菜单中，选择Tools->Generate JavaDoc 。生成JavaDoc。

2. 在打开的对话框中，选择一个范围-您要为其生成引用的一组文件或目录，并设置将放置生成的文档的输出目录。

3. 该输出目录是一个必填字段：只要它是空的，你不能生成的Javadoc文件。

4. 使用滑块定义将包含在生成的文档中的成员的可见性级别。

5. 您可以指定语言环境（例如zh_CN），命令行参数和最大堆大小（例如-encoding utf8 -docencoding utf8 -charset utf8）。

6. 单击确定以生成参考。

• Generate JavaDoc scope：源代码对象的选择，一般以模块（Module）为主，也可指定单独代码文件
• Locale： 键入所需的语言环境。（例如zh_CN）
• Other command line arguments：输入要传递给JavaDoc的其他参数。使用命令行语法。（例如-encoding utf8 -docencoding utf8 -charset utf8 ）

疑难排解：

• javadoc: 错误 - 格式错误的语言环境名称 （清除“Locale”字段，按照上述建议填选语言环境。）
• javadoc: 错误: 编码GBK的不可映射字符 （由于文件中包含中文字符，编码失败。按照上述建议填选编码和字符集。）
• javadoc: 警告 - 没有程序包 * 的源文件 （Javadoc命令行参数错误，参考 javadoc -help）
  

IDEA官方帮助文档：https://www.jetbrains.com/help/idea/2020.3/working-with-code-documentation.html
javadoc官方帮助文档：https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html