JDK11下如何使用Javadoc生成带左侧导航栏的HTML文档

图1：期望生成的带左侧导航栏Javadoc效果
图2：JDK11环境下默认生成的无侧边栏Javadoc效果

问题描述 #

图1是期望生成的Javadoc文档效果，图2是JDK11环境下直接使用Javadoc生成的文档效果，需要怎样配置操作，才能生成图1所示的带左侧导航栏的HTML文档？

解决方法 #

JDK 9 版本开始，Javadoc工具默认生成无框架的单页HTML文档，也就是图2展示的效果。JDK11环境下要生成带左侧导航栏的框架式文档，只需在执行Javadoc命令时添加--frames参数即可。

• 命令行直接生成参考命令：

javadoc --frames -d 文档输出目录 源码文件路径

• Maven项目配置（maven-javadoc-plugin）：在插件配置项中添加--frames附加参数，配置片段参考：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.4.1</version>
    <configuration>
        <additionalOptions>
            <option>--frames</option>
        </additionalOptions>
    </configuration>
</plugin>

• Gradle项目配置：在javadoc任务配置中加入参数，配置片段参考：

javadoc {
    options.addStringOption("-frames")
}

注意：--frames参数仅在JDK9~JDK12版本中提供支持，JDK13及以上版本官方彻底移除了框架式Javadoc的生成能力，更高版本JDK需要借助自定义Doclet或第三方文档生成工具实现同类侧边栏效果，当前使用的JDK11可直接通过上述参数满足需求。

内容的提问来源于stack exchange，提问作者CHUN LI