如何在Gradle中为JDK 10项目启用HTML5 Javadoc

我之前升级JDK10的时候也碰到过这个警告，其实在Gradle里配置Javadoc生成HTML5很简单，只需要给javadoc任务加上对应的配置就行，下面分两种常用的构建脚本写法给你示例：

Groovy DSL（build.gradle） #

直接在构建脚本中配置javadoc任务，启用HTML5格式输出：

javadoc {
    // 启用HTML5格式，消除版本警告
    options.html5 = true
    // 如果你用的是较旧版本的Gradle，上面的写法可能不生效，可以用这个兼容方式
    // options.addStringOption('html5', 'true')
}

Kotlin DSL（build.gradle.kts） #

如果你的项目采用Kotlin风格的构建脚本，配置方式如下：

tasks.javadoc {
    options.html5 = true
    // 兼容旧版Gradle的写法
    // options.addStringOption("html5", "true")
}

额外说明 #

• 配置完成后重新执行Gradle构建，那个HTML版本的警告就会消失，同时生成的Javadoc会采用HTML5格式。
• 如果后续需要切换回HTML4格式，只需要把html5替换成html4即可（对应options.html4 = true或者addStringOption('html4', 'true')）。
• 建议使用Gradle 5.x及以上版本，它对JDK10的兼容性更好，能更好地支持这个配置项。

内容的提问来源于stack exchange，提问作者Ringo Store