Java 9 Javadoc 生成 HTML5 文档与搜索功能

HTML5 文档生成

Java 9 之前 javadoc 生成 HTML 4.0 格式文档。Java 9 新增 -html5 选项生成现代 HTML5 文档，并内置搜索框，大幅提升 API 查阅体验。

对比演示

旧版生成 (JDK 7)

C:\JAVA> javadoc -d C:/JAVA Tester.java
# 生成传统框架式文档，无搜索功能

新版生成 (JDK 9+)

C:\JAVA> javadoc -d C:/JAVA -html5 Tester.java
# 生成 HTML5 文档，包含搜索索引、响应式布局

示例源码

/** 
 * @author MahKumar
 * @version 0.1 
 */
public class Tester {
    /**
     * 默认方法打印 Hello world
     * @param args 命令行参数
     */
    public static void main(String[] args) {
        System.out.println("Hello World");
    }
}

HTML5 文档特性

语义化标签（<header>、<nav>、<section>、<article>）。
响应式设计，适配移动端浏览。
客户端搜索：生成 search.js 与索引文件，无需服务端支持即可全文检索类、方法、字段。
改进的导航栏与类层级视图。

常用 Javadoc 选项速查

选项	说明
`-d <dir>`	输出目录
`-html5`	生成 HTML5 格式（Java 9+）
`-sourcepath <path>`	源码根路径
`-subpackages <pkg>`	递归处理子包
`-encoding UTF-8`	指定源码编码
`-docencoding UTF-8`	指定输出编码
`-version -author`	包含版本/作者标签

模块化项目文档生成

javadoc -d docs -html5 --module-path mods --module com.example.app

也可结合 Maven (maven-javadoc-plugin) 或 Gradle (javadoc task) 自动化生成。

Java 9 JShell REPL：交互式编码与测试利器 Java 9 多版本 JAR：单一归档适配多平台类版本

java