Java 9 - ulepszone JavaDocs

Dokumentację Java można wygenerować za pomocą narzędzia javadoc. Obecnie generuje dokumentację w formacie html 4.0. W java 9 możemy wygenerować dokumentację w formacie html 5 używając opcji -html5 w argumentach wiersza poleceń.

Dokumentacja Java w starym stylu

Rozważ następujący kod w folderze 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");
   }
}

Teraz uruchom narzędzie javadoc z jdk 7, aby wygenerować dokumentację.

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:\JAVA\Tester.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-noframe.html...
Generating C:\JAVA\index.html...
Generating C:\JAVA\help-doc.html...

Utworzy stronę dokumentacji Java w katalogu C: / JAVA, a zobaczysz następujące dane wyjściowe.

Nowa dokumentacja java z obsługą wyszukiwania i HTML5

Uruchom narzędzie javadoc z jdk 9 z flagą -html5, aby wygenerować nowy typ dokumentacji.

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:\JAVA\Tester.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...

Utworzy zaktualizowaną stronę dokumentacji java w katalogu D: / test i zobaczysz następujące dane wyjściowe.