如何生成 HTML5 有效的 Javadoc?
How to generate HTML5 valid Javadoc?
我在 Eclipse Luna 中生成了 HTML5 JavaDoc,点击 Project
-> Generate Javadoc...
输出是格式正确的标准 Javadoc HTML 文件,但是 HTML5 无效。例如,我觉得不合适,因为我想将整个文档上传到网站。
我已经用 W3 Validator 测试了生成的文件。
如何强制生成器生成 HTML5 有效文件,包括页面开头的 <!DOCTYPE html>
并避免 frameset
等过时元素或根本不完整的元素。
据我所知,这将通过 jep-224 在 jdk-9 中提供。在java 8 中,当前类型是html4
。
在当前 (Photon) Eclipse select Package Explorer 视图中的项目并转到:
项目 > 生成 Javadoc ...
这会将您带到 Javadoc 设置的第 1 页。
select输入 Javadoc 命令路径、项目、可见性和输出文件夹后,单击 下一步 按钮 两次 以进入设置的第 3 页,您可以在其中为 Javadoc.exe 命令输入各种选项。
输入 -html5 作为您的 VM 选项。
最好在 Javadoc 选项框中输入 -noqualifier all,以便从每个 class 中删除限定符前缀。否则,最终 Javadoc 的 Modifier & Type 和 Method 列中的对象将作为 java.lang.String 而不是 String 和 ArrayList 作为 java.util.ArrayList。 (对于具有专有 classes 的 HashMap classes,它变得更长更愚蠢)这样做的效果是降低文档的可读性并减少(最重要的)[=38] 的可用宽度=]描述列。
您还可以在此处添加自定义标签等其他选项,例如
-tag custom.date:a:"Date: "
所以标签
@custom.date: November 2018
显示为
Date: November 2018
在最终的 Javadoc 中。
最后点击完成按钮开始生成HTML5格式的javadoc。
我在 Eclipse Luna 中生成了 HTML5 JavaDoc,点击 Project
-> Generate Javadoc...
输出是格式正确的标准 Javadoc HTML 文件,但是 HTML5 无效。例如,我觉得不合适,因为我想将整个文档上传到网站。
我已经用 W3 Validator 测试了生成的文件。
如何强制生成器生成 HTML5 有效文件,包括页面开头的 <!DOCTYPE html>
并避免 frameset
等过时元素或根本不完整的元素。
据我所知,这将通过 jep-224 在 jdk-9 中提供。在java 8 中,当前类型是html4
。
在当前 (Photon) Eclipse select Package Explorer 视图中的项目并转到:
项目 > 生成 Javadoc ...
这会将您带到 Javadoc 设置的第 1 页。 select输入 Javadoc 命令路径、项目、可见性和输出文件夹后,单击 下一步 按钮 两次 以进入设置的第 3 页,您可以在其中为 Javadoc.exe 命令输入各种选项。 输入 -html5 作为您的 VM 选项。
最好在 Javadoc 选项框中输入 -noqualifier all,以便从每个 class 中删除限定符前缀。否则,最终 Javadoc 的 Modifier & Type 和 Method 列中的对象将作为 java.lang.String 而不是 String 和 ArrayList 作为 java.util.ArrayList。 (对于具有专有 classes 的 HashMap classes,它变得更长更愚蠢)这样做的效果是降低文档的可读性并减少(最重要的)[=38] 的可用宽度=]描述列。
您还可以在此处添加自定义标签等其他选项,例如
-tag custom.date:a:"Date: "
所以标签
@custom.date: November 2018
显示为
Date: November 2018
在最终的 Javadoc 中。
最后点击完成按钮开始生成HTML5格式的javadoc。