Exécution de la génération de la documentation depuis la ligne de commande

De RAD Studio
Aller à : navigation, rechercher

Remonter à Procédures de génération de la documentation

Vous pouvez exécuter GenDocCLI.EXE depuis la ligne de commande pour générer la documentation au format HTML sur les projets de modélisation. GenDocCLI.EXE peut s'exécuter selon deux modes :

  • Affichage de l'aide
  • Génération de la documentation

Affichage de l'aide dans la fenêtre console

  1. Pour démarrer l'interpréteur de commandes, cliquez sur Démarrer, puis sur Exécuter. Dans la boîte de dialogue Exécuter, tapez cmd dans le champ Ouvrir et cliquez sur OK. L'interpréteur de commandes s'ouvre.
  2. A l'invite de commande de l'interpréteur de commandes, spécifiez le sous-répertoire \bin de votre installation RAD Studio. Par exemple, vous pouvez exécuter la commande suivante :
    cd "C:\Program Files (x86)\Embarcadero\Studio\21.0\bin"
  1. Exécutez une des lignes de commande suivantes :
GenDocCLI -h
GenDocCLI --help
De brèves instructions sur l'usage de GenDocCLI.EXE apparaissent dans la fenêtre console.

Génération de la documentation sur un projet de modélisation

  1. Démarrez l'interpréteur de commandes.
  2. Exécutez l'outil de génération de la documentation en invoquant, au niveau de l'invite de commande, l'application GenDocCLI.EXE. Pour cela, exécutez une ligne de commande comme suit :
GenDocCLI <options>
Pour consulter la description des options que vous pouvez utiliser, voir la section GenDocCLI.EXE, l'outil de génération de la documentation en ligne de commande de la rubrique Fonctionnalité de génération de la documentation.

Exemple

L'exemple suivant illustre l'exécution de la génération de la documentation depuis la ligne de commande :

 GenDocCLI.exe --without-diagrams --without-navigation -q^
 -U"C:\Program Files (x86)\Embarcadero\Studio\21.0\lib\release"^
 -I"C:\Program Files (x86)\Embarcadero\Studio\21.0\lib";"C:\Program Files (x86)\Embarcadero\Studio\21.0\include"^
 -DDEBUG;DEVELOPERS;^ 
 -o "C:\Utilisateurs\<utilisateur>\Documents\Embarcadero\Studio\Projects\p1\out\Doc"^
 "C:\Utilisateurs\<utilisateur>\Documents\Embarcadero\Studio\Projects\p1\Project1.dproj"

Options de la ligne de commande

Cet exemple illustre l'usage des options suivantes :

  • --without-diagrams -- définit que GenDocCLI.EXE n'insèrera pas les images des diagrammes dans les fichiers de documentation générés au format HTML.
  • --without-navigation -- définit que GenDocCLI.EXE n'incluera pas une arborescence de navigation dans les fichiers de documentation générés.
  • -q -- définit que GenDocCLI.EXE n'affichera pas ses messages de service dans la fenêtre console.
  • -U -- définit que GenDocCLI.EXE recherchera les unités compilées dans le dossier C:\Program Files (x86)\Embarcadero\Studio\21.0\lib\release.
  • -I -- définit que GenDocCLI.exe utilisera les répertoires d'inclusion C:\Program Files (x86)\Embarcadero\Studio\21.0\lib et C:\Program Files (x86)\Embarcadero\Studio\21.0\include.
  • -D -- définit que GenDocCLI.exe utilisera les symboles de compilation conditionnelle DEBUG et DEVELOPERS.
  • -o -- définit que GenDocCLI.exe enregistrera le HTML généré et les autres fichiers de documentation dans le sous-répertoire C:\Utilisateurs\<utilisateur>\Documents\Embarcadero\Studio\Projects\p1\out\Doc. Notez que vous pouvez utiliser facultativement un caractère espace entre -o et le chemin spécifié.
  • Le fichier Project1.dproj doit être le fichier projet Delphi dont vous voulez documenter le code source et le modèle UML. Si le projet Delphi spécifié ne supporte pas la modélisation, GenDocCLI.exe analysera alors les sources du project et génèrera automatiquement tous les diagrammes de classes nécessaires.

Voir aussi