English 中文(简体)
Java 9 - Improved JavaDocs
  • 时间:2024-11-05

Java 9 - Improved JavaDocs


Previous Page Next Page  

Java documentation can be generated using javadoc tool. It currently generates documentation in html 4.0 format. In java 9, we can generate documentation in html 5 format by using -html5 option in command pne arguments.

Old style java documentation

Consider the following code in C:/JAVA folder.

Tester.java

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

Now run the javadoc tool of jdk 7 to generate documentation.

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-pst.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...

It will create the java documentation page in C:/JAVA directory and you will see the following output.

javadoc output

New java documentation with Search and HTML5 support

Run the javadoc tool of jdk 9 with -html5 flag to generate new type of documentation.

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-pst.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...

It will create the updated java documentation page in D:/test directory and you will see the following output.

javadoc output in java 9 Advertisements