Kategorie reguł

Każda reguła analizy kodu należy do kategorii reguł. Na przykład reguły projektowania obsługują przestrzeganie wytycznych projektowych platformy .NET, a reguły zabezpieczeń pomagają zapobiegać wadom zabezpieczeń. Możesz skonfigurować poziom ważności dla całej kategorii reguł. Możesz również skonfigurować dodatkowe opcje dla poszczególnych kategorii.

W poniższej tabeli przedstawiono różne kategorie reguł analizy kodu i podano link do reguł w każdej kategorii. Zawiera również listę wartości konfiguracji do użycia w pliku EditorConfig w celu zbiorczego konfigurowania ważności reguły dla poszczególnych kategorii. Aby na przykład ustawić stopień surowości naruszeń reguł bezpieczeństwa jako błędy, wpis EditorConfig to dotnet_analyzer_diagnostic.category-Security.severity = error.

Wskazówka

Ustawienie ważności dla kategorii reguł przy użyciu dotnet_analyzer_diagnostic.category-<category>.severity składni nie ma zastosowania do reguł, które są domyślnie wyłączone. Jednak począwszy od platformy .NET 6, możesz użyć właściwości projektu AnalysisMode<Category> , aby włączyć wszystkie reguły w kategorii.

Reguły projektowania

	Wartość
Łącze do reguł	Reguły projektowania
Opis	Reguły projektowania obsługują przestrzeganie wytycznych dotyczących projektowania struktury.
Wartość EditorConfig	dotnet_analyzer_diagnostic.category-Design.severity
Wartość właściwości MSBuild	<AnalysisModeDesign>

Reguły dokumentacji

	Wartość
Łącze do reguł	Reguły dokumentacji
Opis	Reguły dokumentacji wspierają pisanie dobrze udokumentowanych bibliotek poprzez poprawne użycie komentarzy dokumentacji XML dla zewnętrznie widocznych interfejsów API.
Wartość EditorConfig	dotnet_analyzer_diagnostic.category-Documentation.severity
Wartość właściwości MSBuild	<AnalysisModeDocumentation>

Reguły globalizacji

	Wartość
Łącze do reguł	Reguły globalizacji
Opis	Reguły globalizacji wspierają biblioteki i aplikacje przygotowane na rynek globalny.
Wartość EditorConfig	dotnet_analyzer_diagnostic.category-Globalization.severity
Wartość właściwości MSBuild	<AnalysisModeGlobalization>

Reguły przenośności i współdziałania

	Wartość
Łącze do reguł	Reguły przenośności i współdziałania
Opis	Reguły przenośności obsługują przenośność na różnych platformach. Reguły współdziałania obsługują interakcję z klientami COM.
Wartość EditorConfig	dotnet_analyzer_diagnostic.category-Interoperability.severity
Wartość właściwości MSBuild	<AnalysisModeInteroperability>

Reguły utrzymywalności

	Wartość
Łącze do reguł	Reguły konserwacji
Opis	Zasady utrzymania wspierają utrzymanie biblioteki i aplikacji.
Wartość EditorConfig	dotnet_analyzer_diagnostic.category-Maintainability.severity
Wartość właściwości MSBuild	<AnalysisModeMaintainability>

Reguły nazewnictwa

	Wartość
Łącze do reguł	Reguły nazewnictwa
Opis	Reguły nazewnictwa pomagają w przestrzeganiu konwencji nazewnictwa zgodnych z wytycznymi dotyczącymi projektowania platformy .NET.
Wartość EditorConfig	dotnet_analyzer_diagnostic.category-Naming.severity
Wartość właściwości MSBuild	<AnalysisModeNaming>

Reguły wydajności

	Wartość
Łącze do reguł	Reguły wydajności
Opis	Reguły wydajności obsługują biblioteki i aplikacje o wysokiej wydajności.
Wartość EditorConfig	dotnet_analyzer_diagnostic.category-Performance.severity
Wartość właściwości MSBuild	<AnalysisModePerformance>

Reguły SingleFile

	Wartość
Łącze do reguł	Reguły pojedynczego pliku
Opis	Reguły pojedynczego pliku obsługują aplikacje jednoplikowe.
Wartość EditorConfig	dotnet_analyzer_diagnostic.category-SingleFile.severity
Wartość właściwości MSBuild	<AnalysisModeSingleFile>

Reguły dotyczące niezawodności

	Wartość
Łącze do reguł	Reguły niezawodności
Opis	Reguły niezawodności obsługują bibliotekę i niezawodność aplikacji, takie jak prawidłowe użycie pamięci i wątków.
Wartość EditorConfig	dotnet_analyzer_diagnostic.category-Reliability.severity
Wartość właściwości MSBuild	<AnalysisModeReliability>

Reguły zabezpieczeń

	Wartość
Łącze do reguł	Reguły zabezpieczeń
Opis	Reguły zabezpieczeń wspierają bezpieczniejsze biblioteki i aplikacje. Te reguły pomagają zapobiegać wadom zabezpieczeń w programie.
Wartość EditorConfig	dotnet_analyzer_diagnostic.category-Security.severity
Wartość właściwości MSBuild	<AnalysisModeSecurity>

Reguły stylów

	Wartość
Łącze do reguł	Reguły stylów
Opis	Reguły stylów obsługują spójny styl kodu w bazie kodu. Te reguły zaczynają się od prefiksu "IDE".*
Wartość EditorConfig	dotnet_analyzer_diagnostic.category-Style.severity
Wartość właściwości MSBuild	<AnalysisModeStyle>

* Użyj wartości dotnet_analyzer_diagnostic.category-CodeQuality.severity EditorConfig, aby włączyć następujące reguły: IDE0051, IDE0052, IDE0064 i IDE0076. Chociaż te reguły zaczynają się od "IDE", nie są one technicznie częścią Style kategorii.

Reguły użycia

	Wartość
Łącze do reguł	Reguły użycia
Opis	Reguły użycia obsługują prawidłowe użycie platformy .NET.
Wartość EditorConfig	dotnet_analyzer_diagnostic.category-Usage.severity
Wartość właściwości MSBuild	<AnalysisModeUsage>