Markdown en comentarios Javadoc
Escribe comentarios Javadoc en Markdown en lugar de HTML para mayor legibilidad.
Comparación 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) { ... }
¿Ves un problema con este código? Cuéntanos.
Por qué gana la forma moderna
Sintaxis natural
Usa acentos graves para código en línea y ``` para bloques en lugar de etiquetas HTML.
Más fácil de escribir
Sin necesidad de {@code}, <pre>, <p> — simplemente escribe Markdown.
Mejor en editores
El Markdown se renderiza perfectamente en IDEs y editores de texto modernos.
Enfoque Antiguo
Javadoc basado en HTML
Enfoque Moderno
Javadoc en Markdown
Desde JDK
23
Dificultad
Principiante
Soporte JDK
Markdown en comentarios Javadoc
Disponible
Disponible desde JDK 23 (sept. 2024)
Cómo funciona
Java 23 introduce los comentarios Javadoc estilo /// en Markdown como alternativa al formato tradicional /** */ basado en HTML. La sintaxis Markdown es más natural de escribir y leer, con soporte para bloques de código, énfasis, listas y enlaces. El compilador convierte el Markdown a HTML para la salida de javadoc.
Documentación Relacionada