Javadoc 주석에서 Markdown 사용
더 나은 가독성을 위해 HTML 대신 Markdown으로 Javadoc 주석을 작성합니다.
코드 비교
✕ 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) { ... }
이 코드에 문제가 있나요? 알려주세요.
모던 방식이 더 나은 이유
자연스러운 구문
HTML 태그 대신 인라인 코드에 백틱, 블록에 ```를 사용합니다.
작성 용이
{@code}, <pre>, <p> 태그 없이 Markdown으로 작성합니다.
편집기에서 더 나음
Markdown은 모던 IDE와 텍스트 편집기에서 아름답게 렌더링됩니다.
이전 방식
HTML 기반 Javadoc
모던 방식
Markdown Javadoc
JDK 버전
23
난이도
초급
JDK 지원
Javadoc 주석에서 Markdown 사용
사용 가능
JDK 23 (2024년 9월) 이후 사용 가능
동작 원리
Java 23은 전통적인 /** */ HTML 기반 형식의 대안으로 /// Markdown 스타일 Javadoc 주석을 도입합니다. Markdown 구문은 더 자연스럽게 작성하고 읽을 수 있으며, 코드 블록, 강조, 목록, 링크를 지원합니다.
관련 문서