Java 9 - JavaDocs aprimorados
A documentação Java pode ser gerada usando a ferramenta javadoc. Atualmente gera documentação em formato html 4.0. Em java 9, podemos gerar documentação no formato html 5 usando a opção -html5 nos argumentos da linha de comando.
Documentação java de estilo antigo
Considere o seguinte código na pasta C:/JAVA.
Testador.java
Demonstração ao vivo/** * @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"); } }
Agora execute a ferramenta javadoc do jdk 7 para gerar a documentação.
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...
Ele criará a página de documentação java no diretório C:/JAVA e você verá a seguinte saída.
Nova documentação java com suporte para pesquisa e HTML5
Execute a ferramenta javadoc do jdk 9 com o sinalizador -html5 para gerar um novo tipo de documentação.
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...
Ele criará a página de documentação java atualizada no diretório D:/test e você verá a seguinte saída.
Java