代码对比
✕ 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 Javadoc 的替代方案。它们在生成的 HTML 文档中正确渲染。
相关文档