如何生成 HTML5 有效的 Javadoc？答案

【问题标题】：How to generate HTML5 valid Javadoc?如何生成 HTML5 有效的 Javadoc？
【发布时间】：2017-11-11 23:40:45
【问题描述】：

我在 Eclipse Luna 中生成了 HTML5 JavaDoc 点击Project -> Generate Javadoc...

输出是格式良好的标准 Javadoc HTML 文件，但是它不是 HTML5 有效的。例如，我觉得不合适，因为我想将整个文档上传到网站。

我已经用W3 Validator测试了生成的文件。

如何强制生成器在页面开头生成包含<!DOCTYPE html> 的HTML5 有效文件，并完全避免frameset 等过时的元素或不完整的元素。

【问题讨论】：

标签： java eclipse html java-8 javadoc

【解决方案1】：

在当前 (Photon) Eclipse 上，在 Package Explorer 视图中选择您的项目并转到：

项目 > 生成 Javadoc ...

这会将您带到 Javadoc 设置的第 1 页。选择 Javadoc 命令路径、项目、可见性和输出文件夹后，单击 下一步 按钮两次进入设置的第 3 页，您可以在其中输入Javadoc.exe 命令的各种选项。输入 -html5 作为您的 VM 选项。

最好在 Javadoc 选项框中输入 -noqualifier all，以便从每个类中删除限定符前缀。否则，最终 Javadoc 的 Modifier & Type 和 Method 列中的对象将作为 java.lang.String 而不是 String 和 ArrayList 作为 java.util.ArrayList 给出。（对于具有专有类的 HashMap 类，它变得更长更愚蠢）这样做的效果是降低文档的可读性并减少（最重要的）Description列的可用宽度。

您还可以在此处为自定义标签等内容添加其他选项，例如

 -tag custom.date:a:"Date: "

这样标记

  @custom.date: November 2018

显示为

  Date: November 2018

在最终的 Javadoc 中。

最后点击完成按钮开始生成HTML5格式的javadocs。

【讨论】：

【解决方案2】：

据我所知，这将在 jdk-9 中通过 jep-224 提供。在 java 8 中，当前类型是html4。

【讨论】：

确实，JDK 9 javadoc 有一个 -html5 选项，但 JDK8 没有。 Eclipse 也使用 JDK javadoc 工具，所以当它可用时，您可以使用该命令行选项。
@Jorn 现在可以在jdk.java.net/9/ 获得，但最近的几个版本已经修复了 HTML5，所以它可能还不完美，它可能不适用于 Luna，但可能适用于 Neon或氧气。