# JEP 467: Markdown 문서 주석

> Clean Markdown view of GeekNews topic #19931. Use the original source for factual precision when an external source URL is present.

## Metadata

- GeekNews HTML: [https://news.hada.io/topic?id=19931](https://news.hada.io/topic?id=19931)
- GeekNews Markdown: [https://news.hada.io/topic/19931.md](https://news.hada.io/topic/19931.md)
- Type: news
- Author: [clickin](https://news.hada.io/@clickin)
- Published: 2025-03-24T16:19:24+09:00
- Updated: 2025-03-24T16:19:24+09:00
- Original source: [openjdk.org](https://openjdk.org/jeps/467)
- Points: 4
- Comments: 3

## Topic Body

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

## Comments



### Comment 36340

- Author: devnamho0910
- Created: 2025-03-25T18:13:19+09:00
- Points: 1

훌륭합니다...

### Comment 36296

- Author: carnoxen
- Created: 2025-03-24T21:09:21+09:00
- Points: 1

표준에 반영되었나 보군요

### Comment 36301

- Author: click
- Created: 2025-03-25T07:45:50+09:00
- Points: 2
- Parent comment: 36296
- Depth: 1

JDK23에 들어갔습니다.  
테스트 해보니 프로젝트의 JDK 버전이 23미만이어도 IDE나 자바독 EXPORT 툴이 지원하면 정상적으로 동작합니다.