Markdown nei commenti Javadoc
Scrivi commenti Javadoc in Markdown invece di HTML per una migliore leggibilità.
Confronto Codice
✕ 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) { ... }
Vedi un problema con questo codice? Faccelo sapere.
Perché vince l'approccio moderno
Sintassi naturale
Usa i backtick per il codice inline e ``` per i blocchi invece dei tag HTML.
Più facile da scrivere
Nessun bisogno di {@code}, <pre>, tag <p> — scrivi semplicemente Markdown.
Migliore negli editor
Il Markdown viene renderizzato splendidamente nei moderni IDE e editor di testo.
Approccio Vecchio
Javadoc basato su HTML
Approccio Moderno
Javadoc Markdown
Dal JDK
23
Difficoltà
Principiante
Supporto JDK
Markdown nei commenti Javadoc
Disponibile
Disponibile dal JDK 23 (settembre 2024)
Come funziona
Java 23 introduce i commenti Javadoc in stile Markdown con /// come alternativa al formato tradizionale /** */ basato su HTML. La sintassi Markdown è più naturale da scrivere e leggere, con supporto per blocchi di codice, enfasi, liste e link. Il compilatore converte il Markdown in HTML per l'output javadoc.
Documentazione Correlata