Markdown dans les commentaires Javadoc
Écrivez des commentaires Javadoc en Markdown plutôt qu'en HTML pour une meilleure lisibilité.
Comparaison de Code
✕ 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) { ... }
Un problème avec ce code ? Dites-le nous.
Pourquoi la méthode moderne gagne
Syntaxe naturelle
Utilisez des backticks pour le code inline et ``` pour les blocs au lieu des balises HTML.
Plus facile à écrire
Sans {@code}, <pre>, <p> — écrivez simplement du Markdown.
Meilleur dans les éditeurs
Le Markdown se rendu parfaitement dans les IDEs et éditeurs de texte modernes.
Ancienne Approche
Javadoc basé sur HTML
Approche Moderne
Javadoc en Markdown
Depuis JDK
23
Difficulté
Débutant
Support JDK
Markdown dans les commentaires Javadoc
Disponible
Disponible depuis JDK 23 (sept. 2024)
Comment ça fonctionne
Java 23 introduit les commentaires Javadoc style /// en Markdown comme alternative au format traditionnel /** */ basé sur HTML. La syntaxe Markdown est plus naturelle à écrire et à lire, avec support des blocs de code, emphase, listes et liens. Le compilateur convertit le Markdown en HTML pour la sortie javadoc.
Documentation Associée