Поделиться через


Категории правил

Каждое правило анализа кода входит в категорию правил. Например, правила разработки поддерживают соответствие рекомендациям по разработке .NET, а правила безопасности помогают устранять уязвимости безопасности. Для всей категории правил можно настроить уровень серьезности . Кроме того, для отдельных категорий можно настроить дополнительные параметры.

В следующей таблице представлены различные категории правил анализа кода и приводятся ссылки на правила в каждой категории. В ней также приведено значение конфигурации, используемое в файле EditorConfig для массовой настройки серьезности правил на уровне каждой категории. Например, чтобы установить серьезность нарушений правил безопасности на уровне ошибок, запись EditorConfig имеет значение dotnet_analyzer_diagnostic.category-Security.severity = error.

Совет

Установка серьезности для категории правил с помощью синтаксиса dotnet_analyzer_diagnostic.category-<category>.severity не применяется к правилам, отключенным по умолчанию. Однако начиная с .NET 6 можно использовать свойство проекта AnalysisMode<Category> , чтобы включить все правила в категории.

Правила разработки

Значение
Ссылка на правила Правила проектирования
Description Правила проектирования поддерживают соблюдение рекомендаций по проектированию Платформы.
Значение EditorConfig dotnet_analyzer_diagnostic.category-Design.severity
Значение свойства MSBuild <AnalysisModeDesign>

Правила документирования

Значение
Ссылка на правила Правила документации
Description Правила документации поддерживают написание хорошо задокументированных библиотек путем правильного использования комментариев XML-документации для видимых извне API-интерфейсов.
Значение EditorConfig dotnet_analyzer_diagnostic.category-Documentation.severity
Значение свойства MSBuild <AnalysisModeDocumentation>

Правила глобализации

Значение
Ссылка на правила Правила глобализации
Description Правила глобализации поддерживают международные библиотеки и приложения.
Значение EditorConfig dotnet_analyzer_diagnostic.category-Globalization.severity
Значение свойства MSBuild <AnalysisModeGlobalization>

Правила переносимости и взаимодействия

Значение
Ссылка на правила Правила переносимости и взаимодействия
Description Правила переносимости поддерживают возможность переноса между различными платформами. Правила взаимодействия поддерживают взаимодействие с клиентами COM.
Значение EditorConfig dotnet_analyzer_diagnostic.category-Interoperability.severity
Значение свойства MSBuild <AnalysisModeInteroperability>

Правила удобства поддержки

Значение
Ссылка на правила Правила обслуживания
Description Правила удобства поддержки распространяются на обслуживание библиотек и приложений.
Значение EditorConfig dotnet_analyzer_diagnostic.category-Maintainability.severity
Значение свойства MSBuild <AnalysisModeMaintainability>

Правила именования

Значение
Ссылка на правила Правила именования
Description Правила именования поддерживают соблюдение соглашений об именовании в соответствии с рекомендациями по проектированию .NET.
Значение EditorConfig dotnet_analyzer_diagnostic.category-Naming.severity
Значение свойства MSBuild <AnalysisModeNaming>

Правила производительности

Значение
Ссылка на правила Правила производительности
Description Правила производительности поддерживают высокоэффективные библиотеки и приложения.
Значение EditorConfig dotnet_analyzer_diagnostic.category-Performance.severity
Значение свойства MSBuild <AnalysisModePerformance>

Правила для одного файла

Значение
Ссылка на правила Правила для одного файла
Description Правила для одного файла поддерживают приложения с одним файлом.
Значение EditorConfig dotnet_analyzer_diagnostic.category-SingleFile.severity
Значение свойства MSBuild <AnalysisModeSingleFile>

Правила надежности

Значение
Ссылка на правила Правила надежности
Description Правила надежности поддерживают безотказность библиотек и приложений, например посредством правильного использования памяти и потоков.
Значение EditorConfig dotnet_analyzer_diagnostic.category-Reliability.severity
Значение свойства MSBuild <AnalysisModeReliability>

Правила безопасности

Значение
Ссылка на правила Правила безопасности
Description Правила безопасности поддерживают безопасность библиотек и приложений. Эти предупреждения помогают устранить уязвимости в программе.
Значение EditorConfig dotnet_analyzer_diagnostic.category-Security.severity
Значение свойства MSBuild <AnalysisModeSecurity>

Правила стилей

Значение
Ссылка на правила Правила стилей
Description Правила стилей поддерживают единообразный стиль кода в базе кода. Эти правила начинаются с префикса интегрированной среды разработки.*
Значение EditorConfig dotnet_analyzer_diagnostic.category-Style.severity
Значение свойства MSBuild <AnalysisModeStyle>

* Используйте значение dotnet_analyzer_diagnostic.category-CodeQuality.severity EditorConfig, чтобы включить следующие правила: IDE0051, IDE0052, IDE0064 и IDE0076. Хотя эти правила начинаются с интегрированной среды разработки, они не являются технической частью Style категории.

Правила использования

Значение
Ссылка на правила Правила использования
Description Правила использования поддерживают надлежащее использование .NET.
Значение EditorConfig dotnet_analyzer_diagnostic.category-Usage.severity
Значение свойства MSBuild <AnalysisModeUsage>