Jede Codeanalyseregel gehört zu einer Regelkategorie. Designregeln unterstützen beispielsweise die Einhaltung der .NET-Entwurfsrichtlinien, und Sicherheitsregeln tragen dazu bei, Sicherheitsfehler zu verhindern. Sie können den Schweregrad für eine gesamte Regelkategorie konfigurieren. Sie können auch zusätzliche Optionen pro Kategorie konfigurieren.
Die folgende Tabelle zeigt die verschiedenen Codeanalyseregelkategorien und stellt einen Link zu den Regeln in jeder Kategorie bereit. 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 auf Fehler festzulegen, lautet dotnet_analyzer_diagnostic.category-Security.severity = errorder EditorConfig-Eintrag .
Tipp
Das Festlegen des Schweregrads für eine Regelkategorie, die die dotnet_analyzer_diagnostic.category-<category>.severity Syntax verwendet, 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
Dokumentationsregeln
|
Wert |
|
Verknüpfung mit Regeln |
Dokumentationsregeln |
|
Beschreibung |
Dokumentationsregeln unterstützen das Schreiben gut dokumentierter Bibliotheken mithilfe der richtigen Verwendung von XML-Dokumentationskommentaren für extern sichtbare APIs. |
|
EditorConfig-Wert |
dotnet_analyzer_diagnostic.category-Documentation.severity |
|
MSBuild-Eigenschaftswert |
<AnalysisModeDocumentation> |
Globalisierungsregeln
|
Wert |
|
Verknüpfung 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üpfung 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üpfung mit Regeln |
Wartbarkeitsregeln |
|
Beschreibung |
Wartungsregeln unterstützen Bibliotheks- und Anwendungswartung. |
|
EditorConfig-Wert |
dotnet_analyzer_diagnostic.category-Maintainability.severity |
|
MSBuild-Eigenschaftswert |
<AnalysisModeMaintainability> |
Benennungsregeln
|
Wert |
|
Verknüpfung 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> |
|
Wert |
|
Verknüpfung 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üpfung mit Regeln |
SingleFile-Regeln |
|
Beschreibung |
Einzeldateiregeln unterstützen Einzeldateianwendungen. |
|
EditorConfig-Wert |
dotnet_analyzer_diagnostic.category-SingleFile.severity |
|
MSBuild-Eigenschaftswert |
<AnalysisModeSingleFile> |
Zuverlässigkeitsregeln
|
Wert |
|
Verknüpfung 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üpfung mit Regeln |
Sicherheitsregeln |
|
Beschreibung |
Sicherheitsregeln unterstützen sicherere Bibliotheken und Anwendungen. Diese Regeln tragen dazu bei, Sicherheitsfehler in Ihrem Programm zu verhindern. |
|
EditorConfig-Wert |
dotnet_analyzer_diagnostic.category-Security.severity |
|
MSBuild-Eigenschaftswert |
<AnalysisModeSecurity> |
Stilregeln
|
Wert |
|
Verknüpfung mit Regeln |
Stilregeln |
|
Beschreibung |
Stilregeln fördern einen konsistenten Code-Stil 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, IDE0064 und IDE0076. Obwohl diese Regeln mit "IDE" beginnen, sind sie technisch nicht Teil der Style Kategorie.
Nutzungsregeln
|
Wert |
|
Verknüpfung mit Regeln |
Nutzungsregeln |
|
Beschreibung |
Nutzungsregeln unterstützen die ordnungsgemäße Verwendung von .NET. |
|
EditorConfig-Wert |
dotnet_analyzer_diagnostic.category-Usage.severity |
|
MSBuild-Eigenschaftswert |
<AnalysisModeUsage> |
