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では///を使ったMarkdownスタイルのJavadocコメントが従来の/** */HTMLベースの形式の代替として導入されました。Markdownの構文はより自然に読み書きでき、コードブロック、強調、リスト、リンクをサポートします。コンパイラはMarkdownをHTMLに変換してjavadoc出力を生成します。
関連ドキュメント