AuditsCLI.EXE: Das Befehlszeilen-Tool für Audits und Metriken

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu Befehlszeilenhilfsprogramme - Index


AuditsCLI.EXE ist das Befehlszeilen-Tool für Audits und Metriken. Es führt, je nachdem, ob die Option --audits oder --metrics in der Befehlszeile angegeben wurde, die Befehlszeilenversion der Audits oder Metriken aus.

Warnung: Beachten Sie, dass AuditsCLI.EXE nur für Delphi-Projekte verwendet werden kann.

Befehlszeilensyntax

Um die Hilfe für die Befehlszeile anzuzeigen, geben Sie Folgendes ein:

AuditsCLI {-h|--help}

Verwenden Sie zum Ausführen von Audits die folgende Befehlszeile:

AuditsCLI --audits --{html|xml} CompilerOptions ^
[--config=AuditsConfigurationFile.ADT] [-o OutputFile] ProjectName.DPROJ

Verwenden Sie zum Ausführen von Metriken die folgende Befehlszeile:

AuditsCLI --metrics --[html|xml] CompilerOptions ^
[--config=MetricsConfigurationFile.MTS] [-o OutputFile] ProjectName.DPROJ

Befehlszeilenoptionen

Die folgenden Befehlszeilenoptionen stehen zur Verfügung:

Option Beschreibung

-h
--help

Wenn Sie eine dieser Optionen angeben, wird die Kurzhilfe im Konsolenfenster angezeigt.

--audits
--metrics

Eine dieser beiden Optionen muss angegeben werden.

  • audits – Führt die Audit-Analyse durch.
  • metrics – Führt die Metrikanalyse durch.

--html
--xml

Eine dieser beiden Optionen muss angegeben werden:

  • html – Gibt das Analyseergebnis im HTML-Format aus.
  • xml – Gibt das Analyseergebnis im XML-Format aus.

CompilerOptionen

Legt Optionen für den Delphi-Compiler fest (siehe DCC32.EXE: Der Delphi-Befehlszeilen-Compiler). Die folgenden Optionen stehen zur Verfügung:

  • -U<Pfade> – Diese Option muss angegeben werden! Sie definiert Verzeichnisse, in denen AuditsCLI.EXE nach compilierten Units sucht. Die Option hat das folgende Format:
-UPfad1;Pfad2.... Jeder Pfad_N muss ein Verzeichnis angeben, in dem compilierte Delphi-Units enthalten sein können. Ein Beispiel:
-U"C:\Program Files (x86)\Embarcadero\Studio\21.0\lib\win32\debug";C:\MyUnits
  • -I<Pfade> – Definiert Include-Verzeichnisse. Die Option hat das folgende Format:
-IPfad1;Pfad2.... Jeder Pfad_N muss ein Include-Verzeichnis angeben.
-DSymbol1;Symbol2.... Jedes Symbol_N muss ein bedingtes Compilierungssymbol angeben.
  • -A<Unit>=<Alias> – Definiert Aliase für Units.

--config=KonfigurationsDatei

Gibt die Datei an, in der ein Audit- oder Metrik-Set für die Analyse gespeichert ist. Die aktivierte Analyse verarbeitet nur die Audits oder Metriken, die in diesem Set gespeichert sind.

  • Für Audits hat die Option das folgende Format:
--config=AuditsKonfigurationsDatei.ADT. AuditsKonfigurationsDatei muss die Datei bezeichnen, die das Audit-Set enthält. Der Dateiname muss die Erweiterung .ADT besitzen.
  • Für Metriken hat die Option das folgende Format:
--config=MetrikenKonfigurationsDatei.MTS. MetrikenKonfigurationsDatei muss die Datei bezeichnen, die das Metrik-Set enthält. Der Dateiname muss die Erweiterung .MTS besitzen.

Konfigurationsdateien können in der IDE erstellt werden. In den Dialogfeldern QS-Audits bzw. QS-Metriken können Sie die Sets der aktiven Audits und Metriken bearbeiten. Speichern Sie anschließend die bearbeiteten Audit- und Metrik-Sets mit der Schaltfläche Audit-Set speichern oder Metrik-Set speichern in Konfigurationsdateien.

Wenn die Option config nicht angegeben wird, wird die Analyse anhand der Standard-Audit- bzw. -Metrik-Sets ausgeführt. Sie können diese Standard-Sets in der IDE überprüfen (siehe den Abschnitt Aktive Audit- und Metrik-Sets im Thema Qualitätssicherungsfunktionen).

-o AusgabeDatei

AusgabeDatei gibt die Ausgabedatei an, in der AuditsCLI.EXE die ermittelten Analyseergebnisse speichert. Wenn Sie einen relativen Pfad, wie .\doc, verwenden, dann handelt es sich um einen relativen Pfad zu dem Projektstammverzeichnis, das in der Option
ProjektName.DPROJ angegeben ist. Standardmäßig wird der Ausgabedateiname
ProjektName.[audits|metrics].[html|xml] (abhängig von der angegebenen Option) verwendet. Sie können optional zwischen -o und AusgabeDatei ein Leerzeichen einfügen.

ProjektName.DPROJ

Gibt die Delphi-Projektdatei an. Diese Datei muss die Dateinamenserweiterung .DPROJ besitzen. Sie sollte von der IDE erstellt werden.
Diese Option muss angegeben werden!

Befehlszeilenbeispiele

Das folgende Beispiel zeigt die Ausführung von Befehlszeilenmetriken:

AuditsCLI.exe --metrics --html^
--config="C:\Users\<Benutzer>\Documents\Embarcadero\Studio\Projects\MyMetrics.mts"^
-U"C:\Program Files (x86)\Embarcadero\Studio\21.0\lib\release"^
-o "C:\Users\<Benutzer>\Documents\Embarcadero\Studio\Projects\p1\QA\MyMetricsResults.html"^
"C:\Users\<Benutzer>\Documents\Embarcadero\Studio\Projects\p1\Project1.dproj"

Die Optionen bedeuten hier Folgendes:

  • --html definiert, dass die Metrikergebnisse im HTML-Format erzeugt werden.
  • Die Datei MyMetrics.mts speichert das Set der auszuführenden Metriken. Diese Datei muss zuvor im Dialogfeld QS-Metrik erstellt worden sein.
  • -U definiert, dass die Befehlszeilenmetriken im Ordner
C:\Program Files (x86)\Embarcadero\Studio\21.0\lib\release nach compilierten Units suchen.
  • -I definiert, dass die Befehlszeilen-Audits die Include-Verzeichnisse
  • Die Datei Project1.dproj muss die Projektdatei sein, deren Quelltext von den Befehlszeilenmetriken analysiert werden soll.


Das folgende Beispiel zeigt die Ausführung von Befehlszeilen-Audits:

AuditsCLI.exe --audits --html^
--config="C:\Users\<Benutzer>\Documents\Embarcadero\Studio\Projects\MyAudits.adt"^
-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 .\MyAuditsResults.html^
"C:\Users\<Benutzer>\Documents\Embarcadero\Studio\Projects\p1\Project1.dproj"

Die Optionen bedeuten hier Folgendes:

C:\Users\<Benutzer>\Documents\Embarcadero\Studio\Projects\p1 erstellt werden muss, das in der Projektdateioption festgelegt ist.
C:\Users\<Benutzer>\Documents\Embarcadero\Studio\Projects\p1 erstellt werden muss, das in der Projektdateioption festgelegt ist.

Themen

Siehe auch

Abgerufen von „http://docwiki.embarcadero.com/RADStudio/Sydney/d/index.php?title=AuditsCLI.EXE:_Das_Befehlszeilen-Tool_für_Audits_und_Metriken&oldid=216314“