跳到主要内容

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 增加了网页的语义价值,使创建可访问的网页变得更加容易。

描述

  • 标准 doclet 中添加了一个命令行选项,以请求特定类型的输出标记。当前类型 HTML4 将成为默认类型。 HTML5 将成为 JDK 10 中的默认设置。

  • header通过使用、footernav等结构性 HTML5 元素,提高了生成的 HTML 的语义价值_。_

  • HTML5 标记实现了WAI-ARIA 标准以实现可访问性。使用 role 属性将特定角色分配给 HTML 文档中的元素。

  • -Xdoclint功能已更新,可根据请求的输出标记类型检查文档注释中是否存在常见错误。

测试

提供测试以确保:

  • HTML5 标记有效
  • HTML5 标记可访问
  • 新的命令行选项可以正常工作
  • HTML5 标记适用于所有支持的浏览器

缺乏测试可访问性的自动化工具阻碍了全面的可访问性测试。可以使用基于网络的在线工具检查不同类型页面的代表性样本。