Question

我在Eclipse Luna中点击了Project - ＆gt;生成了HTML5 JavaDoc。 Generate Javadoc...

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

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

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

Answer 1

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

Answer 2

在当前（Photon）Eclipse上，在Package Explorer视图中选择您的项目，然后转到：

项目>生成Javadoc ...

这使您进入Javadoc设置的第1页。选择Javadoc命令路径，项目，可见性和输出文件夹后，单击 Next 按钮两次进入设置的第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。

如何生成HTML5有效的Javadoc？

2 个答案: