JavaDoc 更新 - 一口 Java

比利·科兰多 于 2022 年 4 月 14 日

在每次发布中，JavaDoc 工具和官方 JDK JavaDoc 都得到了稳定的改进。让我们回顾一下 JDK 11 和 JDK 18 之间发生的一些变化。

响应式 UI

生成的 JavaDoc 现在对不同的屏幕分辨率更具响应性。对 JavaDoc 的更改包括：顶部菜单在通常在移动设备上找到的分辨率下变为“汉堡包”菜单，重新调整页面以更好地适应较小的屏幕分辨率，并解决众多图形故障。这些更改应该让在移动设备上查看 JavaDoc 的体验更加愉快。

JavaDoc 将自动生成指向继承或实现的方法或字段的超类或接口的链接。这可以更容易地查找和理解类的继承行为，或接口如何让客户端使用 API。如果超类是 JDK 类，则链接将指向官方 JDK JavaDoc 中该类的相应版本。

索引页更新

索引页面新增了三个页面；常量字段值、序列化表单和系统属性。这可以轻松引用重要值、序列化行为以及向系统提供值和属性的上下文。

常量字段值

常量字段值页面按包、类和字段名称的字母顺序显示所有常量字段及其值。JavaDoc 工具将自动检测所有常量字段（标记为 public 或 protected 且为 static 和 final 的字段）。

序列化表单

序列化表单页面显示了所有已实现 Serializable 接口的类。在此页面上，类的 serialVersionUID 值以及所有可序列化字段（连同字段的 JavaDoc）都将显示。

系统属性

了解可以设置或提供给系统的所有值对于理解如何正确配置系统非常重要。以前，查找和理解如何使用这些系统属性很困难，因为无法在 JavaDoc 中标记和关联它们。为了解决这一缺点，{@SystemProperty} 标记可用于轻松标记系统属性字段，在 JDK 18 中，这些字段将收集在 系统属性页面上。系统属性页面将提供指向系统属性的 JavaDoc 的链接，该链接应解释如何使用系统属性，以及在适当情况下提供其默认值。

延伸阅读

编程愉快！