Markdown in Javadoc-Kommentaren
Javadoc-Kommentare in Markdown statt HTML schreiben, für bessere Lesbarkeit.
Code-Vergleich
✕ Java 8
/**
* Returns the {@code User} with
* the given ID.
*
* <p>Example:
* <pre>{@code
* var user = findUser(123);
* }</pre>
*
* @param id the user ID
* @return the user
*/
public User findUser(int id) { ... }
✓ Java 23+
/// Returns the `User` with
/// the given ID.
///
/// Example:
/// ```java
/// var user = findUser(123);
/// ```
///
/// @param id the user ID
/// @return the user
public User findUser(int id) { ... }
Problem mit diesem Code entdeckt? Sag uns Bescheid.
Warum der moderne Weg gewinnt
Natürliche Syntax
Backticks für Inline-Code und ``` für Blöcke statt HTML-Tags verwenden.
Einfacher zu schreiben
Kein {@code}, <pre>, <p>-Tags – einfach Markdown schreiben.
Besser in Editoren
Markdown wird in modernen IDEs und Texteditoren hervorragend dargestellt.
Alter Ansatz
HTML-basiertes Javadoc
Moderner Ansatz
Markdown-Javadoc
Seit JDK
23
Schwierigkeitsgrad
Einsteiger
JDK-Unterstützung
Markdown in Javadoc-Kommentaren
Verfügbar
Verfügbar seit JDK 23 (Sept. 2024)
Wie es funktioniert
Java 23 führt ///Markdown-Javadoc-Kommentare als Alternative zum traditionellen /** */-HTML-Format ein. Markdown-Syntax ist natürlicher zu schreiben und zu lesen, mit Unterstützung für Codeblöcke, Betonungen, Listen und Links. Der Compiler wandelt Markdown in HTML für die Javadoc-Ausgabe um.
Zugehörige Dokumentation