JDK 20 对 JavaDoc 做了一些更改。让我们看看这些更改如何帮助您了解预览功能并简化链接。

为用户定义的锚点生成 ID

JavaDoc 现在将自动为 JavaDoc 中的用户定义锚点生成 ID（即 <hN> 标签）。这将改善在 JavaDoc 中提供链接以及外部文档链接到 JavaDoc 的体验。让我们看看生成的 ID 如何与下面的代码示例一起使用

/***
 * Some class level JavaDoc
 * 
 * <h2>About Sample Application</h2>
 * 
 * SampleApplication is a sample application for demonstrating Java doc features.
 * 
 * 
 * <h3>Generated ids</h3>
 * 
 * JavaDoc recently introduced generated ids for user-defined anchors.
 * 
 * Some important info here. 
 * @author bkorando
 *
 */

The <h2> 和 <h3> 标签都将为其生成 ID，遵循将拉丁字符内容的小写化和将空格和非拉丁字符转换为连字符 - 以及附加为后缀的 -heading 的模式。因此，上面两个标题的 ID 将是；about-sample-application-heading 和 generated-ids-heading。如果存在 ID 冲突，JavaDoc 将在 ID 末尾附加一个 int 累加器，例如 generated-ids-heading-1、generated-ids-heading-2。

简化对用户定义锚点的链接

The @see 和 {@link} 标签已更新，以简化对用户定义锚点的链接。我们可以使用以下代码段中先前示例的链接来探索此更新

/***
 * Learn  about sample application 
 * {@link com.oracle.sip.SampleApplication##about-sample-application-heading here}
 *
 * 
 * @see com.oracle.sip.SampleApplication##generated-ids-heading generated ids
 * @param args some args
 */

现在可以使用完全限定的类或文件位置，后跟双井号 (##) 和锚点名称来链接到用户定义的锚点；还必须提供一个额外的标签。上面演示了从第一个示例链接用户定义的链接；{@link com.oracle.sip.SampleApplication##about-sample-application-heading here} 和 @see com.oracle.sip.SampleApplication##generated-ids-heading generated ids。

JavaDoc 中预览功能的更新

官方 JavaDoc 上的预览页面已更新，以便更轻松地查看预览功能的 JEP 并查看与预览功能相关的 API 更改。

提供 JDK 版本中包含的所有预览功能的清单。JEP 的标题是与相关 JEP 的超链接，使用户可以轻松地了解更多关于该功能的信息。取消选中 JEP 名称旁边的框也将删除页面上仅与该 JEP 相关的任何 API 更改。这可以使用户更容易理解与 JDK 相关的 API 更改，这些更改通常难以找到。下面仅显示选择了单个 JEP

其他阅读材料

为用户定义的锚点泛化 see 和 link 标签 (JBS 问题)

自动为用户定义的标题生成 ID (JBS 问题)

在 JavaDoc PREVIEW 页面上列出所有预览功能 (JBS 问题)

JavaDoc 预览页面

编码愉快！