JEP 467: Markdown 문서 주석
(openjdk.org)목표
Java의 문서 주석에서 Markdown 문법을 지원하여 가독성 향상 및 간결한 문서 작성 유도.
동기
- 기존 JavaDoc은 HTML 태그에 의존 → 너무 장황하고 읽기 어려움.
- 개발자들은 이미 README, GitHub 등에서 Markdown에 익숙.
- Markdown 지원으로 일관성 있고 간결한 문서 작성 가능.
설명
- CommonMark 기반 Markdown 문법을 JavaDoc 주석 내에서 지원.
- 기존 HTML 주석도 여전히 사용 가능.
- 기존
/* ... */방식의 주석 대신///를 사용하여 마크다운 문서 주석임을 표기 - 3rd-party JavaDoc 툴이 Markdown을 파싱하고 렌더링 처리.
Markdown 사양
- CommonMark 기반.
- 지원하는 문법:
- 제목(
#,##,###등) - 목록 (순서/비순서)
- 코드 블록 (```)
- 링크
- 표 (Github Flavored Markdown 방식)
- 인용문
- 강조 (
*기울임*,**굵게**)
- 제목(
Java 전용 태그
Markdown과 함께 기존 JavaDoc @-태그 사용 가능:
-
@param -
@return -
@throws -
@see -
@since -
@deprecated