Java Language Costruire Javadocs dalla riga di comando

Esempio

Molti IDE forniscono supporto per generare automaticamente HTML da Javadocs; alcuni strumenti di compilazione ( Maven e Gradle , ad esempio) hanno anche plugin in grado di gestire la creazione HTML.

Tuttavia, questi strumenti non sono necessari per generare l'HTML Javadoc; questo può essere fatto usando lo strumento javadoc riga di comando.

L'uso più basilare dello strumento è:

javadoc JavaFile.java

Che genererà HTML dai commenti Javadoc in JavaFile.java .

Un uso più pratico dello strumento della riga di comando, che leggerà in modo ricorsivo tutti i file java in [source-directory] , creerà la documentazione per [package.name] e tutti i sotto-pacchetti, e posizionerà l'HTML generato nella [docs-directory] è:

javadoc -d [docs-directory] -subpackages -sourcepath [source-directory] [package.name]