javadoc: 错误 - 非法的程序包名称: “UTF-8“ | javadoc: 警告 - 没有程序包encoding的源文件 | javadoc: 错误 - 不支持编码: utf8-charse

前言

本解决方案，主要适用于IDEA，使用步骤：顶部菜单栏Tools--Generate JavaDoc

描述

错误一

javadoc: 错误 - 非法的程序包名称: "UTF-8"
javadoc: 警告 - 没有程序包encoding的源文件

错误二

 javadoc: 错误 - 不支持编码: utf8-charset

步骤

模板一（首次使用可能报错）

Locale:输入语言类型:zh_CN
Other command line arguments:-encoding UTF-8 -charset UTF-8

注：该模板首次运行可能会报错，但是使用过模板三后，再回头使用该模板，发现不报错了。可能是因为需要某些依赖，被模板三运行的时候，自动下载了。 

-encoding utf-8 是文件编码，就是以utf-8编码读取文件和生成javadoc;
-charset utf-8    是生成的javadoc的编码。

模板二

Locale:输入语言类型:zh_CN
Other command line arguments:-encoding utf8 -docencoding utf8-charset utf8

注：该写法，部分电脑不支持，可能原因不支持uft8这种简写，常见写法是utf-8 

模板三(正解)

特别注意：如果上面的两个模板参数，一直报错，就调整为下面代码（是全部，由于arguments比较长，展示的时候可能会被显示为两行）：

Locale:输入语言类型:zh_CN
Other command line arguments:-encoding UTF-8 -charset UTF-8 -windowtitle "文档HTML页面标签的标题" -link http://docs.Oracle.com/javase/7/docs/api

注：使用该模板后，再回头测试模板一，会发现模板一，一开始不能用，现在也能用了。 

示例

依次是：JavaDoc的生成范围、生成位置、指定生成JavaDoc的编码规范

查看生成结果

效果图

 

附注：JavaDoc命令的使用

如果想进一步了解JavaDoc命令，可以打开windows的CMD命令窗口，输入
javadoc -help 
查看查看详细命令

用法示例

javadoc -d api org/eclipse/swt/SWT.java //处理单个源文件
javadoc -d api org.eclipse.swt //处理单个包
javadoc -d api org.eclipse.swt org.eclipse.swt.widgets //处理多个包，如果处理的包较少，可以采用直接输入的方法
javadoc -private -d api @package.txt //处理多个包。生成最完整的帮助文档，包括带有private修饰符的属性和方法。

注：该api的方法，适用于所有java开源项目，只要有源码就可以。