如何生成HTML5有效的Javadoc?

Nik*_*las 5 java eclipse html5 javadoc java-8

我在Eclipse Luna中单击了Project- > 生成了HTML5 JavaDocGenerate Javadoc...

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

我用W3 Validator测试了生成的文件.

如何强制生成器生成HTML5有效文件,包括<!DOCTYPE html>在页面的开头,并frameset根本避免使用过时的元素或不完整的元素.

Eug*_*ene 5

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


Tru*_*unk 1

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

项目 > 生成 Javadoc ...

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

最好在 Javadoc 选项框中输入-noqualifier all,以便从每个类中删除限定符前缀。否则,最终 Javadoc 的Modifier & TypeMethod列中的对象将以 java.lang.String 形式给出,而不是以 java.util.ArrayList 形式给出 String 和 ArrayList。(对于具有专有类的 HashMap 类来说,它变得更长、更愚蠢)这样做的结果是降低了文档的可读性并减少了(最重要的)描述列的可用宽度。

您还可以在此处添加其他选项,例如自定义标签,例如

 -tag custom.date:a:"Date: "
Run Code Online (Sandbox Code Playgroud)

这样标签

  @custom.date: November 2018
Run Code Online (Sandbox Code Playgroud)

显示为

  Date: November 2018
Run Code Online (Sandbox Code Playgroud)

在最终的 Javadoc 中。

最后单击Finish按钮开始生成 HTML5 格式的 javadoc。

Javadoc显示配置