Freigeben über


Regelkategorien

Jede Codeanalyseregel gehört zu einer Regelkategorie. Entwurfsregeln unterstützen z. B. der Einhaltung der .NET-Entwurfsrichtlinien und Sicherheitsregeln der Vermeidung von Sicherheitslücken. Es ist möglich, für eine ganze Kategorie von Regeln den Schweregrad zu konfigurieren. Auch die -Konfiguration zusätzlicher -Optionen pro Kategorie ist möglich.

Die folgende Tabelle gibt einen Überblick über die verschiedenen Regelkategorien für die Codeanalyse und enthält einen Link zu den Regeln der einzelnen Kategorien. Außerdem wird der Konfigurationswert aufgelistet, der in einer EditorConfig-Datei zum Massenkonfigurieren des Regelschweregrads pro Kategorie zu verwenden ist. Um beispielsweise den Schweregrad von Sicherheitsregelverletzungen als Fehler festzulegen, lautet der EditorConfig-Eintrag dotnet_analyzer_diagnostic.category-Security.severity = error.

Tipp

Das Festlegen des Schweregrads für eine Regelkategorie mithilfe der dotnet_analyzer_diagnostic.category-<category>.severity-Syntax gilt nicht für Regeln, die standardmäßig deaktiviert sind. Ab .NET 6 können Sie jedoch die AnalysisMode<Category>-Projekteigenschaft verwenden, um alle Regeln in einer Kategorie zu aktivieren.

Entwurfsregeln

Wert
Verknüpfen mit Regeln Entwurfsregeln
Beschreibung Entwurfsregeln unterstützen die Einhaltung der Framework-Entwurfsrichtlinien.
EditorConfig-Wert dotnet_analyzer_diagnostic.category-Design.severity
MSBuild-Eigenschaftswert <AnalysisModeDesign>

Dokumentationsregeln

Wert
Verknüpfen mit Regeln Dokumentationsregeln
Beschreibung Dokumentationsregeln unterstützen das Schreiben von gut dokumentierten Bibliotheken durch die ordnungsgemäße Verwendung von XML-Dokumentationskommentaren für extern sichtbare APIs.
EditorConfig-Wert dotnet_analyzer_diagnostic.category-Documentation.severity
MSBuild-Eigenschaftswert <AnalysisModeDocumentation>

Globalisierungsregeln

Wert
Verknüpfen mit Regeln Globalisierungsregeln
Beschreibung Globalisierungsregeln unterstützen weltweit einsatzbereite Bibliotheken und Anwendungen.
EditorConfig-Wert dotnet_analyzer_diagnostic.category-Globalization.severity
MSBuild-Eigenschaftswert <AnalysisModeGlobalization>

Portabilitäts- und Interoperabilitätsregeln

Wert
Verknüpfen mit Regeln Portabilitäts- und Interoperabilitätsregeln
Beschreibung Portabilitätsregeln unterstützen die Portabilität auf verschiedenen Plattformen. Interoperabilitätsregeln unterstützen die Interaktion mit COM-Clients.
EditorConfig-Wert dotnet_analyzer_diagnostic.category-Interoperability.severity
MSBuild-Eigenschaftswert <AnalysisModeInteroperability>

Wartbarkeitsregeln

Wert
Verknüpfen mit Regeln Wartbarkeitsregeln
Beschreibung Wartbarkeitsregeln unterstützen die Bibliotheks- und Anwendungswartung.
EditorConfig-Wert dotnet_analyzer_diagnostic.category-Maintainability.severity
MSBuild-Eigenschaftswert <AnalysisModeMaintainability>

Benennungsregeln

Wert
Verknüpfen mit Regeln Benennungsregeln
Beschreibung Benennungsregeln unterstützen die Einhaltung der Benennungskonventionen der .NET-Entwurfsrichtlinien.
EditorConfig-Wert dotnet_analyzer_diagnostic.category-Naming.severity
MSBuild-Eigenschaftswert <AnalysisModeNaming>

Leistungsregeln

Wert
Verknüpfen mit Regeln Leistungsregeln
Beschreibung Leistungsregeln unterstützen leistungsstarke Bibliotheken und Anwendungen.
EditorConfig-Wert dotnet_analyzer_diagnostic.category-Performance.severity
MSBuild-Eigenschaftswert <AnalysisModePerformance>

SingleFile-Regeln

Wert
Verknüpfen mit Regeln SingleFile-Regeln
Beschreibung Regeln für einzelne Dateien unterstützen Einzeldatei-Anwendungen.
EditorConfig-Wert dotnet_analyzer_diagnostic.category-SingleFile.severity
MSBuild-Eigenschaftswert <AnalysisModeSingleFile>

Zuverlässigkeitsregeln

Wert
Verknüpfen mit Regeln Zuverlässigkeitsregeln
Beschreibung Zuverlässigkeitsregeln unterstützen die Bibliotheks- und Anwendungszuverlässigkeit wie beispielsweise die ordnungsgemäße Arbeitsspeicher- und Threadverwendung.
EditorConfig-Wert dotnet_analyzer_diagnostic.category-Reliability.severity
MSBuild-Eigenschaftswert <AnalysisModeReliability>

Sicherheitsregeln

Wert
Verknüpfen mit Regeln Sicherheitsregeln
Beschreibung Sicherheitsregeln unterstützen sicherere Bibliotheken und Anwendungen. Diese Regeln tragen dazu bei, Sicherheitslücken in Ihrem Programm zu vermeiden.
EditorConfig-Wert dotnet_analyzer_diagnostic.category-Security.severity
MSBuild-Eigenschaftswert <AnalysisModeSecurity>

Stilregeln

Wert
Verknüpfen mit Regeln Stilregeln
Beschreibung Stilregeln unterstützen einen konsistenten Codestil in Ihrer Codebasis. Diese Regeln beginnen mit dem Präfix „IDE“.*
EditorConfig-Wert dotnet_analyzer_diagnostic.category-Style.severity
MSBuild-Eigenschaftswert <AnalysisModeStyle>

* Verwenden Sie den EditorConfig-Wert dotnet_analyzer_diagnostic.category-CodeQuality.severity, um die folgenden Regeln zu aktivieren: IDE0051, IDE0052, IDE0064und IDE0076. Diese Regeln beginnen zwar mit „IDE“, sind aber technisch gesehen nicht Teil der Style-Kategorie.

Nutzungsregeln

Wert
Verknüpfen mit Regeln Nutzungsregeln
Beschreibung Nutzungsregeln unterstützen die ordnungsgemäße Verwendung von .NET.
EditorConfig-Wert dotnet_analyzer_diagnostic.category-Usage.severity
MSBuild-Eigenschaftswert <AnalysisModeUsage>