Comment générer Javadoc à partir de la ligne de commande
Quelqu'un peut-il me montrer comment générer Javadoc à partir de la ligne de commande?
Mon projet contient le paquet com.test
et je veux mettre la documentation générée dans des fichiers situés dans un dossier spécifique comme celui-ci: C:/javadoc/test
.
7 answers
Vous pouvez consulter la documentation javadoc 8
Je pense que ce que vous regardez est quelque chose comme
javadoc -d C:/javadoc/test com.test
Oracle fournit quelques exemples simples:
Http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDJBGFC
En supposant que vous êtes dans ~/ et que l'arborescence des sources java est dans ./ saxon_source / net et vous voulez récurser à travers toute l'arborescence source net est à la fois un répertoire et le nom du paquet supérieur.
mkdir saxon_docs
javadoc -d saxon_docs -sourcepath saxon_source -subpackages net
Supposons que vous ayez la structure de répertoires suivante dans laquelle vous souhaitez générer des javadocs sur file1.java
et file2.java
(package com.test), avec les javadocs placés dans C:\javadoc\test
:
C:\
|
+--javadoc\
| |
| +--test\
|
+--projects\
|
+--com\
|
+--test\
|
+--file1.java
+--file2.java
Dans le terminal de commande, accédez à la racine de votre colis: C:\projects
. Si vous souhaitez simplement générer les javadocs standard sur tous les fichiers java du projet, exécutez la commande suivante (pour plusieurs paquets, séparez les noms de paquets par espaces):
C:\projects> javadoc -d [path to javadoc destination directory] [package name]
C:\projects> javadoc -d C:\javadoc\test com.test
Si vous voulez exécuter javadocs à partir de ailleurs, vous devrez spécifier le sourcepath. Par exemple, si vous deviez exécuter javadocs dans C:\
, vous modifieriez la commande en tant que telle:
C:\> javadoc -d [path to javadoc destination directory] -sourcepath [path to package directory] [package name]
C:\> javadoc -d C:\javadoc\test -sourcepath C:\projects com.test
Si vous souhaitez exécuter javadocs uniquement sur selected .fichiers java, puis ajoutez les noms de fichiers source séparés par des espaces (vous pouvez utiliser un astérisque (*) pour un caractère générique). Assurez-vous d'inclure le chemin d'accès aux fichiers:
C:\> javadoc -d [path to javadoc destination directory] [source filenames]
C:\> javadoc -d C:\javadoc\test C:\projects\com\test\file1.java
Plus d'informations/les scénarios peuvent être trouvés ici.
Par exemple si j'avais une structure de code source d'application qui ressemblait à ceci:
- C:\b2b\com\steve\util\
- C:\b2b\com\steve\app\
- C:\b2b\com\steve\gui\
Alors je ferais:
javadoc -d "C:\docs" -sourcepath "C:\b2b" -subpackages com
Et cela devrait créer des javadocs pour le code source dans le paquet com, et tous les sous-paquets (récursivement), trouvés dans le "C:\b2b" répertoire.
C'est simple d'aller dans le dossier où tout votre code java est enregistré, par exemple E:/javaFolder et puis javadoc *.java
Exemple
E:\javaFolder> javadoc *.java
D:>javadoc *.java
Si vous souhaitez créer un fichier dock du package lang, le chemin doit être le même que celui de votre package lang actuellement exemple J'ai créé un nom de dossier javaapi et décompressé le fichier zip src. puis utiliser la commande comme ci-dessous
C:\Users\Techsupport1\Desktop\javaapi\java\lang > javadoc *.java