JEP 467: Markdownドキュメントコメント

(openjdk.org)

4 ポイント投稿者 clickin 2025-03-24 | 3件のコメント | WhatsAppで共有

目標

JavaのドキュメントコメントでMarkdown構文をサポートし、可読性を高め、簡潔なドキュメント作成を促進する。

動機

既存のJavaDocはHTMLタグに依存しており、冗長すぎて読みにくい。
開発者はすでにREADMEやGitHubなどでMarkdownに慣れている。
Markdown対応により、一貫性があり簡潔なドキュメント作成が可能になる。

説明

CommonMarkベースのMarkdown構文をJavaDocコメント内でサポート。
既存のHTMLコメントも引き続き使用可能。
従来の/* ... */形式のコメントの代わりに///を使ってMarkdownドキュメントコメントであることを示す。
サードパーティ製JavaDocツールがMarkdownをパースしてレンダリングする。

Markdown仕様

CommonMarkベース。
サポートする構文:
- 見出し（#、##、### など）
- リスト（順序あり/順序なし）
- コードブロック（```）
- リンク
- 表（Github Flavored Markdown方式）
- 引用文
- 強調（*斜体*、**太字**）

Java専用タグ

Markdownとあわせて既存のJavaDoc @タグも使用可能:

@param
@return
@throws
@see
@since
@deprecated

3件のコメント

devnamho0910 2025-03-25

素晴らしいです...

carnoxen 2025-03-24

標準に反映されたようですね

click 2025-03-25

JDK 23に入りました。
テストしてみたところ、プロジェクトのJDKバージョンが23未満でも、IDEやJavadocのEXPORTツールが対応していれば正常に動作します。