Skip to content

JEP 224: HTML5 Javadoc

摘要

增强javadoc工具以生成HTML5标记。

目标

为标准 doclet 提供选项,要求输出 HTML 4 或 HTML5。HTML5 标记是语义性的,即清晰地将意义与样式和内容区分开。使用 HTML5 标记的标准 doclet 生成的页面部分满足无障碍访问要求。

非目标

将当前的三帧/无帧结构替换为生成的 HTML 页面不是目标;这可能成为未来的 JEP 的主题。

强制使用 HTML5 在文档注释中,也不是目标,提供将使用 HTML 4 编写的文档注释转换为 HTML5 的能力也不是目标。

动机

在 JDK 8 及更早版本中,标准 doclet 生成的是HTML 4.01的页面,这是一个旧标准,不支持满足无障碍访问要求。 HTML5是 HTML 的最新标准。HTML5 增加了网页的语义价值,并使创建无障碍网页更加容易。

描述

  1. 向标准 doclet 添加命令行选项以请求特定的输出标记类型。HTML4 是当前类型,将成为默认类型。HTML5 将成为 JDK 10 中的默认类型。
  2. 通过使用结构性的 HTML5 元素(如headerfooternav等),提高了生成 HTML 的语义价值。
  3. HTML5 标记实现了WAI-ARIA 标准以支持无障碍访问。使用角色属性为 HTML 文档中的元素分配特定角色。
  4. 更新-Xdoclint功能,以根据请求的输出标记类型检查文档注释中常见的错误。

测试

提供测试以确保:

  1. HTML5 标记是有效的。
  2. HTML5 标记是无障碍的。
  3. 新命令行选项工作正常。