Улучшения Javadoc в Java 9
Новые возможности Java 9Инструмент javadoc может создавать документацию Java. В Java 9 вывод javadoc теперь соответствует совместимому стандарту HTML5.
Документация из более старых версий до Java 9
Рассмотрим следующий код файла C:/JAVA/Tester.java:
Пример
/**
* @author MahKumar
* @version 0.1
*/
public class Tester {
/**
* Метод по умолчанию, который будет запущен для вывода
* <p>Привет, мир</p>
* @param args аргументы командной строки
*/
public static void main(String []args) {
System.out.println("Hello World");
}
}
Используйте javadoc из JDK 7 для создания документации:
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...
Выполнение приведённой выше команды создаст страницу документации в C:/JAVA, как показано на рисунке ниже:
Документация, созданная Java 9, совместима со стандартом HTML5
Использование параметра-html5команды javadoc из JDK 9 может обеспечить поддержку стандарта HTML5 созданной документацией:
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...
Выполнение приведённой выше команды создаст страницу документации в C:/JAVA, как показано на рисунке ниже:
