Dokumentationen über die Befehlszeile erzeugen
Nach oben zu Dokumentationserzeugung – Anleitungen
Inhaltsverzeichnis
Mithilfe des Tools GenDocCLI.EXE können Sie in der Befehlszeile die Dokumentation für Modellierungsprojekte im HTML-Format erzeugen. GenDocCLI.EXE kann in zwei Modi ausgeführt werden:
- Anzeigen der Hilfe
- Erzeugen der Dokumentation
Anzeigen der Hilfe im Konsolenfenster
- Klicken Sie zum Starten des Befehlszeilen-Interpreters auf Start und dann auf Ausführen. Geben Sie in das Feld Öffnen des Dialogfelds Ausführen den Befehl
cmd
ein, und klicken Sie auf OK. Der Befehlszeilen-Interpreter wird geöffnet. - Wechseln Sie an der Eingabeaufforderung des Befehlszeilen-Interpreters zum Unterverzeichnis
\bin
Ihrer RAD Studio-Installation. Sie können beispielsweise den folgenden Befehl eingeben:cd "C:\Program Files (x86)\Embarcadero\Studio\17.0\bin"
- Führen Sie einen der folgenden Befehle aus:
GenDocCLI -h GenDocCLI --help
- Daraufhin wird eine Kurzanleitung zur Verwendung von GenDocCLI.EXE im Konsolenfenster angezeigt.
Erzeugen der Dokumentation für ein Modellierungsprojekt
- Starten Sie den Befehlszeilen-Interpreter.
- Führen Sie das Tool zum Erzeugen der Dokumentation aus, indem Sie an der Eingabeaufforderung die Anwendung GenDocCLI.EXE aufrufen. Geben Sie dazu einen Befehl wie den folgenden ein:
GenDocCLI <Optionen>
- Die Beschreibungen der verfügbaren
Optionen
finden Sie im Abschnitt GenDocCLI.EXE: Das Befehlszeilen-Tool zur Dokumentationserzeugung des Themas Dokumentationserzeugung.
- Die Beschreibungen der verfügbaren
Beispiel
Das folgende Beispiel zeigt das Erzeugen einer Dokumentation von der Befehlszeile aus:
GenDocCLI.exe --without-diagrams --without-navigation -q^ -U"C:\Program Files (x86)\Embarcadero\Studio\17.0\lib\release"^ -I"C:\Program Files (x86)\Embarcadero\Studio\17.0\lib";"C:\Program Files (x86)\Embarcadero\Studio\17.0\include"^ -DDEBUG;DEVELOPERS;^ -o "C:\Users\<Benutzer>\Documents\Embarcadero\Studio\Projects\p1\out\Doc"^ "C:\Users\<Benutzer>\Documents\Embarcadero\Studio\Projects\p1\Project1.dproj"
Befehlszeilenoptionen
In diesem Beispiel wird der Einsatz folgender Optionen veranschaulicht:
--without-diagrams
: definiert, dass GenDocCLI.EXE keine Diagrammbilder in die im HTML-Format erzeugten Dokumentationsdateien einfügt.--without-navigation
: definiert, dass GenDocCLI.EXE keine Navigationshierarchie in die im HTML-Format erzeugten Dokumentationsdateien einfügt.-q
: definiert, dass GenDocCLI.EXE keine Service-Meldungen im Konsolenfenster anzeigt.-U
: definiert, dass GenDocCLI.EXE im OrdnerC:\Program Files (x86)\Embarcadero\Studio\17.0\lib\release
nach compilierten Units sucht.-I
: definiert, dass GenDocCLI.exe die Include-VerzeichnisseC:\Program Files (x86)\Embarcadero\Studio\17.0\lib
undC:\Program Files (x86)\Embarcadero\Studio\17.0\include
verwendet.-D
: definiert, dass GenDocCLI.exe die bedingten CompilierungssymboleDEBUG
undDEVELOPERS
verwendet.-o
: definiert, dass GenDocCLI.exe die erzeugten HTML- und anderen Dokumentationsdateien im UnterverzeichnisC:\Users\<Benutzer>\Documents\Embarcadero\Studio\Projects\p1\out\Doc
speichert. Beachten Sie bitte, dass Sie optional zwischen-o
und der Pfadangabe ein Leerzeichen einfügen können.- Die Datei
Project1.dproj
muss die Delphi-Projektdatei sein, deren Quelltext und UML-Modell dokumentiert werden sollen. Wenn das angegebene Delphi-Projekt die Modellierung nicht unterstützt, analysiert GenDocCLI.exe die Projektquelldateien und erzeugt automatisch alle erforderlichen Klassendiagramme.