web-dev-qa-db-fra.com

Comment générer Javadoc à partir de la ligne de commande

Quelqu'un peut-il me montrer comment générer Javadoc à partir d'une ligne de commande?

Mon projet contient le package 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.

javacommand-linejavadoc
55
Damir

Vous pouvez vous référer au documentation javadoc 8

Je pense que ce que vous regardez ressemble à ceci:

javadoc -d C:\javadoc\test com.test
43
Arun P Johny

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 source Java se trouve dans ./saxon_source/net et que vous souhaitez utiliser l'ensemble de 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
25
infogizmo

Supposons que vous disposiez de la structure de répertoires suivante dans laquelle vous souhaitez générer des javadocs sur file1.Java et file2.Java (package com.test), les javadocs étant 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 paquet: 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 packages, séparez les noms de package par des espaces):

C:\projects> javadoc -d [path to javadoc destination directory] [package name]

C:\projects> javadoc -d C:\javadoc\test com.test

Si vous souhaitez exécuter des javadocs à partir d’autres sources, vous devez spécifier le chemin source. Par exemple, si vous exécutiez des 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 des javadocs uniquement sur des fichiers .Java sélectionnés, 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/scénarios peuvent être trouvés ici .

12
shimizu

Par exemple, si j'avais une structure de code source d'application ressemblant à 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 du package com et tous les sous-packages (de manière récursive) situés dans le répertoire "C:\b2b".

6
Rakesh Soni

son simple aller dans le dossier où tout Java est enregistré disons E:/javaFolder puis javadoc *.Java

exemple

E:\javaFolder> javadoc *.Java

3
kshitij

D:> javadoc * .Java

si vous voulez créer un fichier dock du paquet lang, le chemin doit être le même que votre paquet lang, par exemple, j'ai créé un nom de dossier javaapi et décompressez le fichier zip src. puis utilisez la commande ci-dessous

C:\Utilisateurs\Techsupport1\Desktop\javaapi\Java\lang> javadoc * .Java

1
Sachindra N. Pandey

Lien vers JavaDoc

Je crois que cela va sûrement vous aider.

javadoc -d C:/javadoc/test com.mypackage
1
Simpal Kumar