Udostępnij za pośrednictwem


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. Na przykład aby ustawić ważność naruszeń reguły zabezpieczeń na błędy, wpis EditorConfig to dotnet_analyzer_diagnostic.category-Security.severity = error.

Napiwek

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 obsługują pisanie dobrze udokumentowanych bibliotek przy użyciu poprawnych komentarzy dokumentacji XML dla zewnętrznych 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 obsługują biblioteki i aplikacje gotowe do użycia na świecie.
Wartość EditorConfig dotnet_analyzer_diagnostic.category-Globalization.severity
Wartość właściwości MSBuild <AnalysisModeGlobalization>

Reguły dotyczące 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 utrzymania kodu

Wartość
Łącze do reguł Reguły konserwacji
Opis Reguły konserwacji obsługują bibliotekę i konserwację 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 obsługują przestrzeganie konwencji nazewnictwa wytycznych dotyczących 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 pojedynczego pliku

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ń obsługują 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>