如何在 gradle 中为 JavaDoc 设置编码？答案

【问题标题】：How to set an encoding for the JavaDoc in gradle?如何在 gradle 中为 JavaDoc 设置编码？
【发布时间】：2014-11-12 18:22:57
【问题描述】：

我用包含äöü 等特殊字符的JavaDoc 命令编写了Java 类。我使用 gradle 构建文件生成 JavaDoc：

apply plugin: 'java'

在命令行中：gradle javadoc。

原始文件的编码是 UTF-8。 JavaDoc 文件的编码也是 UTF-8。但是 HTML 源中没有任何提示，文件是 UTF-8。这就是为什么我的浏览器总是认为它是ISO-8859。

如何告诉 javadoc（通过 gradle）在生成 JavaDoc 时也将 <meta charset="utf-8"/> 添加到源代码中？

【问题讨论】：

【解决方案1】：

您需要设置 javadoc charset option。

javadoc {
    options.encoding = 'UTF-8'
}

【讨论】：

【解决方案2】：

我使用的是 gradle 2.13+，Mark 的回答和 Arne 的评论都不适合我。

不过，我可以通过 addStringOption() 修复它：

javadoc {
    options.addStringOption("charset", "UTF-8")
}

有关详细信息，请参阅 gradles Javadoc 文档和 Javadoc 中的 charset 选项。

【讨论】：

【解决方案3】：

我使用的是 Gradle 2.1，发现以下配置适合我。

tasks.withType(Javadoc) {
    options.encoding = 'UTF-8'
}

【讨论】：

【解决方案4】：

对我来说是这样的：

javadoc {
    options.addStringOption('encoding', 'UTF-8')
}

在 Gradle 3.3 中

【讨论】：