Implementieren von benutzerdefinierten Eincheckrichtlinien für die Codeanalyse für verwalteten Code

Eine Eincheckrichtlinie für die Codeanalyse legt einen Regelsatz fest, den Mitglieder eines Azure DevOps-Projekts auf den Quellcode anwenden müssen, bevor dieser in die Versionskontrolle eingecheckt wird. Microsoft stellt eine Reihe von Standardregelsätzen bereit, die Codeanalyseregeln in Funktionsbereiche gruppieren. Benutzerdefinierte Regelsätze für Eincheckrichtlinien geben eine Reihe von Codeanalyseregeln an, die für ein bestimmtes Projekt gelten. Ein Regelsatz wird in einer RULESET-Datei gespeichert.

Eincheckrichtlinien werden auf der Azure DevOps-Projektebene festgelegt und durch den Speicherort einer RULESET-Datei in der Versionskontrollstruktur angegeben. Bezüglich des Versionskontrollspeicherorts für den benutzerdefinierten Regelsatz einer Teamrichtlinie gelten keine Einschränkungen.

Die Codeanalyse wird für die einzelnen Codeprojekte im Eigenschaftenfenster für jedes Projekt konfiguriert. Ein benutzerdefinierter Regelsatz für ein Codeprojekt wird durch den physischen Speicherort der RULESET-Datei auf dem lokalen Computer angegeben. Wenn eine RULESET-Datei angegeben wird, die sich auf demselben Laufwerk wie das Codeprojekt befindet, verwendet Visual Studio in der Projektkonfiguration einen relativen Pfad zu der Datei.

Eine empfohlene Vorgehensweise beim Erstellen eines benutzerdefinierten Regelsatzes für ein Azure DevOps-Projekt besteht darin, die RULESET-Datei für die Eincheckrichtlinie in einem speziellen Ordner zu speichern, der nicht Teil eines Codeprojekts ist. Wenn Sie die Datei in einem dedizierten Ordner speichern, können Sie mithilfe von Berechtigungen einschränken, wer die Regeldatei bearbeiten darf. Außerdem können Sie die Verzeichnisstruktur, die das Projekt enthält, problemlos in ein anderes Verzeichnis oder auf einen anderen Computer verschieben.

Erstellen des benutzerdefinierten Eincheckregelsatzes für ein Projekt

Um einen benutzerdefinierten Regelsatz für ein Azure DevOps-Projekt zu erstellen, erstellen Sie zunächst im Quellcodeverwaltungs-Explorer einen speziellen Ordner für den Eincheckrichtlinien-Regelsatz. Dann erstellen Sie die Regelsatzdatei und fügen die Datei der Versionskontrolle hinzu. Abschließend legen Sie den Regelsatz als Eincheckrichtlinie für die Codeanalyse für das Projekt fest.

Hinweis

Zum Erstellen eines Ordners in einem Azure DevOps-Projekt müssen Sie zunächst das Stammverzeichnis des Projekts einem Speicherort auf dem lokalen Computer zuordnen.

So erstellen Sie den Versionskontrollordner für den Regelsatz der Eincheckrichtlinie

1. Erweitern Sie im Team Explorer den Projektknoten, und klicken Sie dann auf Quellcodeverwaltung.

2. Klicken Sie im Bereich Ordner mit der rechten Maustaste auf das Projekt, und klicken Sie dann auf Neuer Ordner.

3. Klicken Sie im Hauptbereich der Quellcodeverwaltung mit der rechten Maustaste auf Neuer Ordner, klicken Sie auf Umbenennen, und geben Sie einen Namen für den Regelsatzordner ein.

So erstellen Sie den Regelsatz für die Eincheckrichtlinie

1. Zeigen Sie im Menü Datei auf Neu, und klicken Sie dann auf Datei.

2. Klicken Sie in der Liste Kategorien auf Allgemein.

3. Doppelklicken Sie in der Liste Vorlagen auf Regelsatz für Codeanalyse.

4. Geben Sie die Regeln an, die in den Regelsatz aufgenommen werden sollen, und speichern Sie die Regelsatzdatei dann in dem von Ihnen erstellten Regelsatzordner.

So fügen Sie die Regelsatzdatei der Versionskontrolle hinzu

1. Klicken Sie im Quellcodeverwaltungs-Explorer mit der rechten Maustaste auf den neuen Ordner, und klicken Sie dann auf Elemente zu Ordner hinzufügen.

   Weitere Informationen finden Sie unter Git- und Azure-Repositorys.

2. Klicken Sie auf die von Ihnen erstellte Regelsatzdatei und dann auf Fertig stellen.

   Die Datei wird der Quellcodeverwaltung hinzugefügt und für Sie ausgecheckt.

3. Klicken Sie im Detailfenster des Quellcodeverwaltungs-Explorers mit der rechten Maustaste auf den Dateinamen, und klicken Sie dann auf Ausstehende Änderungen einchecken.

4. Im Dialogfeld Einchecken können Sie einen Kommentar hinzufügen und dann auf Einchecken klicken.

   Hinweis

   Wenn Sie für Ihr Azure DevOps-Projekt bereits eine Eincheckrichtlinie für die Codeanalyse konfiguriert haben und die Option Einchecken von Dateien erzwingen, sodass nur Dateien enthalten sind, die Teil der aktuellen Projektmappe sind aktiviert wurde, lösen Sie eine Warnung zu einem Richtlinienfehler aus. Wählen Sie im Dialogfeld „Richtlinienfehler“ die Option Richtlinienfehler überschreiben und Eincheckvorgang fortsetzen aus. Fügen Sie einen Kommentar (erforderlich) hinzu, und klicken Sie dann auf OK.

So geben Sie die Regelsatzdatei als Eincheckrichtlinie an

1. Zeigen Sie im Menü Team auf Projekteinstellungen, und klicken Sie dann auf Quellcodeverwaltung.

2. Klicken Sie auf Eincheckrichtlinie und dann auf Hinzufügen.

3. Doppelklicken Sie in der Liste Richtlinien einchecken auf Codeanalyse, und stellen Sie sicher, dass das Kontrollkästchen Codeanalyse für verwalteten Code erzwingen aktiviert ist.

4. Klicken Sie in der Liste Diesen Regelsatz ausführen auf <Regelsatz aus Quellcodeverwaltung auswählen>.

5. Geben Sie den Pfad der Eincheckrichtlinien-Regelsatzdatei in der Versionskontrolle ein.

   Der Pfad muss der folgenden Syntax entsprechen:

   $/ TeamProjectName / VersionControlPath

   Hinweis

   Sie können den Pfad mit einem der folgenden Verfahren im Quellcodeverwaltungs-Explorer kopieren:

   • Klicken Sie im Bereich Ordner auf den Ordner, der die Regelsatzdatei enthält. Kopieren Sie den Versionskontrollpfad des Ordners, der im Feld Quelle angezeigt wird, und geben Sie den Namen der Regelsatzdatei manuell ein.

   • Klicken Sie im Detailfenster mit der rechten Maustaste auf die Regelsatzdatei und dann auf Eigenschaften. Kopieren Sie den Wert, der auf der Registerkarte Allgemein in Servername angezeigt wird.

Synchronisieren von Codeprojekten mit dem Regelsatz für Eincheckrichtlinien

Wenn Sie ein Codeprojekt konfigurieren, geben Sie einen Projektregelsatz für die Eincheckrichtlinien im Eigenschaftendialogfeld des Codeprojekts als Regelsatz für die Codeanalyse an. Wenn sich der Regelsatz auf demselben Laufwerk befindet wie das Codeprojekt, wird bei Auswahl des Pfades im Dateidialogfeld ein relativer Pfad zur Angabe des Regelsatzes verwendet. Durch den relativen Pfad können die Projekteinstellungen auf andere Computer übertragen werden, die ähnliche lokale Versionskontrollstrukturen verwenden.

So legen Sie einen Projektregelsatz als Regelsatz für ein Codeprojekt fest

1. Rufen Sie bei Bedarf den Ordner und die Datei des Regelsatzes für die Eincheckrichtlinie aus der Versionskontrolle ab.

   Sie können diesen Schritt im Quellcodeverwaltungs-Explorer ausführen, indem Sie mit der rechten Maustaste auf den Regelsatzordner klicken und dann auf Neueste Version abrufen klicken.

2. Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf das Codeprojekt, und klicken Sie anschließend auf Eigenschaften.

3. Klicken Sie auf Codeanalyse.

4. Klicken Sie bei Bedarf auf die geeigneten Optionen in den Listen Konfiguration und Plattform.

5. Um die Codeanalyse jedes Mal auszuführen, wenn das Codeprojekt mit der angegebenen Konfiguration erstellt wird, wählen Sie im Abschnitt Binäre Analysetools die Option Beim Erstellen ausführen.

6. Klicken Sie in der Liste Diesen Regelsatz ausführen auf <Durchsuchen>.

7. Wählen Sie die lokale Version der Regelsatzdatei für die Eincheckrichtlinie aus.