Freigeben über

Richtlinien für die Verwendung von Codeanalysetools

  • Artikel

In der folgenden Liste werden Richtlinien für die Auswahl und Verwaltung von Codeanalysewarnungen aufgeführt.

Empfohlen

  • Machen Sie sich mit den Warnkategorien vertraut.

    Da Codeanalysetools zum Aufspüren von Codefehlern umfangreiche Überprüfungen durchführen, ist es nützlich, wenn Sie über ein grundlegendes Verständnis der verschiedenen Warnungen verfügen. Weitere Informationen zu Warnkategorien finden Sie unter Warnungen bei der Analyse von verwaltetem Code oder Codeanalyse für C/C++-Warnungen

  • Analysieren Sie vorhandenen Code.

    Wählen Sie je nach Projekttyp, Ressourcen und Anforderungen die am besten geeignete Methode aus.

    • Aktivieren Sie alle Warnungen.

      Aktivieren Sie alle Warnungen, und überprüfen Sie dann anhand der vom Analysetool generierten Warnliste, welche Warnungen aktiviert sein sollen.

    • Aktivieren Sie eine Teilmenge von Warnungen.

      Wählen Sie aus den Warnkategorien eine Teilmenge von Warnungen aus, die im Projekt verwendet werden sollen, und aktivieren Sie nur diese.

  • Analysieren Sie Code, der sich noch in der Entwicklungsphase befindet.

    Da hierbei noch kein fertiger Code vorhanden ist, empfiehlt es sich, alle Warnungen zu aktivieren und den Code während der gesamten Entwicklungsphase im Hinblick auf Fehler zu analysieren. Sowohl die Analyse als auch die Korrektur von Code ist während der Entwicklung sehr viel einfacher. Warten Sie mit der Codeanalyse oder der Aktivierung zahlreicher Warnungen nicht bis zum Ende des Entwicklungszyklus. Dadurch werden die Teammitglieder nur unnötig unter Druck gesetzt, und zudem können Codesicherheit und Stabilität gefährdet sein.

  • Verfolgen Sie Warnungen nach.

    Verfolgen Sie die Warnungen, die Sie für das Projekt aktiviert haben, mithilfe der Funktionen für die Arbeitsüberwachung nach. Weitere Informationen finden Sie in einem der folgenden Themen:

    Gewusst wie: Erstellen einer Arbeitsaufgabe für einen Fehler in verwaltetem Code

    Gewusst wie: Erstellen einer Arbeitsaufgabe für C/C++-Codefehler

    Gewusst wie: Erstellen einer Arbeitsaufgabe aus einem Transact-SQL-Codefehler

  • Beheben Sie Warnungen.

    Sie können Warnungen auf folgende Weise korrigieren:

    • Korrigieren: Korrigieren Sie den Code, und testen Sie ihn vor dem Einchecken.

    • Unterdrücken: Sie können das System.Diagnostics.CodeAnalysis.SuppressMessageAttribute-Attribut in verwaltetem Code verwenden, um eine Warnung zu unterdrücken, die von Code an einer bestimmten Position verursacht wurde.

    • Deaktivieren: Auf den Projekteigenschaftenseiten können Sie Warnungen für den gesamten verwalteten Code deaktivieren. Für C/C++ können Sie eine Headerdatei verwenden, in der alle Warnungen aufgelistet werden. Aktivieren Sie mithilfe dieser Datei Warnungen bzw. deaktivieren Sie solche, die nicht für das Projekt erforderlich sind.

    Ändern Sie nach dem Beheben der Warnung den Status von Warnung in Fehler. Auf diese Weise halten Sie den Code sauber.

  • Geben Sie Eincheckanforderungen an.

    Sie können Eincheckrichtlinien für den Code definieren und darin festlegen, dass die Codeanalyse ausgeführt werden muss. Nur Code, der die Analyse besteht, darf eingecheckt werden. Dies hilft sicherzustellen, dass eingecheckter Code in Ordnung ist. Weitere Informationen zu Eincheckrichtlinien finden Sie unter Erstellen und Verwenden von Eincheckrichtlinien für die Codeanalyse.