如何在 Java 9 中创建符合 HTML5 的 Javadoc?


在 Java 9 之前,我们不得不在谷歌中搜索才能找出特定的 接口方法 信息。从 Java 9 开始,Javadoc API 文档本身中包含了搜索选项,并且输出 符合 HTML5 标准

在以下示例中,我们在 "C:/JAVA" 文件夹中创建了 "JavaDocTest.java" 文件。

示例

public class JavaDocTest {
   /**
      * Default method to be run to print
      * Tutorialspoint 
      * @param args command-line arguments
   */
   public static void main(String args[]) {
      System.out.println("Tutorialspoint");
   }
}

Java 9 生成的文档与 HTML5 标准兼容。通过在jdk 9 Javadoc 命令 中使用 "-html5" 参数,可以让生成的文档支持HTML5 标准

C:\JAVA>javadoc -d C:/JAVA -html5 JavaDocTest.java
Loading source file JavaDocTest.java...
Constructing Javadoc information...
Standard Doclet version 9.0.4
Building tree for all the packages and classes...
Generating C:\JAVA\JavaDocTest.html...
Generating C:\JAVA\package-frame.html...
Generating C:\JAVA\package-summary.html...
Generating C:\JAVA\package-tree.html...
Generating C:\JAVA\constant-values.html...
Building index for all the packages and classes...
Generating C:\JAVA\overview-tree.html...
Generating C:\JAVA\index-all.html...
Generating C:\JAVA\deprecated-list.html...
Building index for all classes...
Generating C:\JAVA\allclasses-frame.html...
Generating C:\JAVA\allclasses-frame.html...
Generating C:\JAVA\allclasses-noframe.html...
Generating C:\JAVA\allclasses-noframe.html...
Generating C:\JAVA\index.html...
Generating C:\JAVA\help-doc.html...

执行以上命令可以在 "C:/JAVA" 文件夹下生成一个文档页面,如下所示

更新于: 20-4-2020

214 次浏览

职业生涯起步

通过完成课程获得认证

开始
广告
© . All rights reserved.