Markdown em comentários Javadoc
Escreva comentários Javadoc em Markdown em vez de HTML para melhor legibilidade.
Comparação de Código
✕ 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) { ... }
Viu um problema com este código? Nos avise.
Por que a forma moderna ganha
Sintaxe natural
Use crases para código inline e ``` para blocos em vez de tags HTML.
Mais fácil de escrever
Sem necessidade de {@code}, <pre>, <p> — basta escrever Markdown.
Melhor em editores
Markdown renderiza lindamente em IDEs e editores de texto modernos.
Abordagem Antiga
Javadoc baseado em HTML
Abordagem Moderna
Javadoc com Markdown
Desde o JDK
23
Dificuldade
Iniciante
Suporte JDK
Markdown em comentários Javadoc
Disponível
Disponível desde o JDK 23 (set 2024)
Como funciona
O Java 23 introduz comentários Javadoc no estilo Markdown com /// como alternativa ao formato tradicional /** */ baseado em HTML. A sintaxe Markdown é mais natural para escrever e ler, com suporte a blocos de código, ênfase, listas e links. O compilador converte o Markdown para HTML na saída do javadoc.
Documentação Relacionada