Java9 - 改进的 JavaDocs

创建于 2024-12-02 / 21
字体: [默认] [大] [更大]

可以使用 javadoc 工具生成 Java 文档。 它目前生成 html 4.0 格式的文档。 在 Java9 中,我们可以通过在命令行参数中使用 -html5 选项来生成 html 5 格式的文档。


旧式 java 文档

考虑 C:JAVA 文件夹中的以下代码。

Tester.java

/**
  * @author MahKumar
  * @version 0.1
*/
public class Tester {
   /**
      * Default method to be run to print 
      * <p>Hello world</p>
      * @param args command line arguments
   */
   public static void main(String []args) {
      System.out.println("Hello World");
   }
}

现在运行jdk 7的javadoc工具生成文档。

C:JAVA>javadoc -d C:/JAVA Tester.java
Loading source file tester.java...
Constructing Javadoc information...
Standard Doclet version 1.7.0_21
Building tree for all the packages and classes...
Generating C:JAVATester.html...
Generating C:JAVApackage-frame.html...
Generating C:JAVApackage-summary.html...
Generating C:JAVApackage-tree.html...
Generating C:JAVAconstant-values.html...
Building index for all the packages and classes...
Generating C:JAVAoverview-tree.html...
Generating C:JAVAindex-all.html...
Generating C:JAVAdeprecated-list.html...
Building index for all classes...
Generating C:JAVAallclasses-frame.html...
Generating C:JAVAallclasses-noframe.html...
Generating C:JAVAindex.html...
Generating C:JAVAhelp-doc.html...

它将在 C:JAVA 目录中创建 java 文档页面,您将看到以下输出。

javadoc 输出

支持搜索和 HTML5 的新 java 文档

使用 -html5 标志运行 jdk 9 的 javadoc 工具以生成新类型的文档。

C:JAVA> javadoc -d C:/JAVA -html5 Tester.java
Loading source file Tester.java...
Constructing Javadoc information...
Standard Doclet version 9.0.1
Building tree for all the packages and classes...
Generating C:JAVATester.html...
Generating C:JAVApackage-frame.html...
Generating C:JAVApackage-summary.html...
Generating C:JAVApackage-tree.html...
Generating C:JAVAconstant-values.html...
Building index for all the packages and classes...
Generating C:JAVAoverview-tree.html...
Generating C:JAVAindex-all.html...
Generating C:JAVAdeprecated-list.html...
Building index for all classes...
Generating C:JAVAallclasses-frame.html...
Generating C:JAVAallclasses-frame.html...
Generating C:JAVAallclasses-noframe.html...
Generating C:JAVAallclasses-noframe.html...
Generating C:JAVAindex.html...
Generating C:JAVAhelp-doc.html...

它将在 D:\test 目录中创建更新的 java 文档页面,您将看到以下输出。

Java9 中的 javadoc 输出

0 人点赞过