Skip to content

生成 java api 文档时的一些错误处理

使用 IDEA 生成 java api doc

java-doc

java-doc

错误: 编码GBK的不可映射字符

java-doc

Command line arguments 添加下面参数可解决

-encoding UTF-8 -charset UTF-8

原因说明

直接执行 javadoc 会按我们使用的 windows 操作系统默认的 GBK 编码处理,所以需要指定编码

错误: 未知标记: date 和 description

Command line arguments 添加下面参数可解决

原因说明

如果我们设置了类注释模板,而使用的一些标签不被 javadoc 所识别,则需要通过命令行的参数方式来进行说明

-tag date:a:时间 -tag description:a:说明

java-doc

添加命令行参数可执行成功

java-doc