Java 9 – Verbesserte JavaDocs
Die Java-Dokumentation kann mit dem Javadoc-Tool generiert werden. Es generiert derzeit Dokumentation im HTML 4.0-Format. In Java 9 können wir Dokumentation im HTML 5-Format generieren, indem wir die Option -html5 in den Befehlszeilenargumenten verwenden.
Java-Dokumentation im alten Stil
Betrachten Sie den folgenden Code im Ordner C:/JAVA.
Tester.java
Live-Demo
/**
* @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");
}
}
Führen Sie nun das Javadoc-Tool von jdk 7 aus, um Dokumentation zu generieren.
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...
Es wird die Java-Dokumentationsseite im C:/JAVA-Verzeichnis erstellen und Sie werden die folgende Ausgabe sehen.
Neue Java-Dokumentation mit Such- und HTML5-Unterstützung
Führen Sie das Javadoc-Tool von jdk 9 mit dem Flag -html5 aus, um einen neuen Dokumentationstyp zu generieren.
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...
Es wird die aktualisierte Java-Dokumentationsseite im Verzeichnis D:/test erstellen und Sie werden die folgende Ausgabe sehen.
Java