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 werden 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 nicht bis zum Ende des Entwicklungszyklus, um dann den Code zu analysieren oder zahlreiche Warnungen zu aktivieren. 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 ausgewählt haben, mithilfe der Features für die Arbeitsüberwachung nach. Weitere Informationen finden Sie unter Gewusst wie: Hinzufügen neuer Arbeitsaufgaben.

  • Beheben Sie Warnungen.

    Es gibt verschiedene Methoden zum Beheben einer Warnung:

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

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

    • Deaktivieren: Sie können mithilfe der Projekteigenschaftenseiten 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, in dem während der Analyse keine Fehler gefunden werden, darf eingecheckt werden. Auf diese Weise wird gewährleistet, dass nur fehlerfreier Code eingecheckt wird. Weitere Informationen zu Eincheckrichtlinien finden Sie unter Eincheckrichtlinien für die Codeanalyse.