Java 9: HTML5 Javadoc generieren mit dem Javadoc-Tool (-html5 Option)

Neu in Java 9: HTML5 Output

Der javadoc-Generator produzierte bis Java 8 HTML 4.01. Ab Java 9 erzeugt die Option -html5 valides, modernes HTML5 mit semantischen Elementen (<header>, <nav>, <section>, <article>) und integrierter Suchfunktion (Client-seitig, JavaScript-basiert).

Vergleich: Alt (Java 8) vs. Neu (Java 9 + -html5)

Beispielklasse `Tester.java`

/**
 * @author Max Mustermann
 * @version 0.1
 */
public class Tester {
    /**
     * Hauptmethode – gibt Gruß aus.
     * Hello world
     * @param args Kommandozeilenargumente
     */
    public static void main(String[] args) {
        System.out.println("Hello World");
    }
}

Java 8 Javadoc (HTML 4)

C:\JAVA> javadoc -d C:/JAVA Tester.java
Loading source file Tester.java...
Constructing Javadoc information...
Standard Doclet version 1.8.0_xxx
Generating C:\JAVA\Tester.html...
Generating C:\JAVA\package-frame.html...
Generating C:\JAVA\package-summary.html...
... (Frames-basiert, keine Suche)

Java 9 Javadoc mit `-html5`

C:\JAVA> javadoc -d C:/JAVA -html5 Tester.java
Loading source file Tester.java...
Constructing Javadoc information...
Standard Doclet version 9.0.1
Generating C:\JAVA\Tester.html...
Generating C:\JAVA\search.html        <-- NEU: Suchindex
Generating C:\JAVA\module-summary.html <-- NEU: Modul-Übersicht
... (HTML5, semantisch, responsive, durchsuchbar)

Wichtige Neuerungen im HTML5 Doclet

Suchleiste in der generierten Doku (clientseitig, offline-fähig).
Responsive Design – nutzbar auf Mobile/Tablet.
Semantisches HTML5 – bessere Accessibility (Screenreader).
Modul-Seiten – Übersicht aller Module, Pakete pro Modul.
Keine Frames mehr (Standard) – Single-Page-Layout mit Navigation.
Neue Tags: {@index}, {@summary} (siehe Java 10).

Wichtige javadoc-Optionen (Java 9+)

Option	Beschreibung
`-html5`	HTML5 Output erzwingen (ab JDK 9 Default in JDK 11+).
`--add-stylesheet <file>`	Zusätzliches CSS-Stylesheet einbinden (Java 10+).
`--overridden-methods=value`	Überschriebene Methoden gruppieren (Java 10+).
`-module <name>`	Dokumentiert nur das angegebene Modul.
`--module-path <path>`	Modulpfad für abhängige Module.
`-docencoding <enc>`	Encoding der Output-Dateien (Default UTF-8).

Best Practice

javadoc -d docs -html5 \
        --module-path mods \
        -sourcepath src \
        -subpackages com.meinprojekt

Für Module-Projekte: -module oder --module-source-path nutzen.

Java 9 JShell (REPL): Interaktives Coding & Testen leicht gemacht Java 9 Multi-Release JAR: Plattformspezifische Klassenversionen in einem Archiv

Java