Каждое правило анализа кода относится к категории правил. Например, правила проектирования поддерживают соблюдение рекомендаций по проектированию .NET, а правила безопасности помогают предотвратить недостатки безопасности. Уровень серьезности можно настроить для всей категории правил. Вы также можете настроить дополнительные параметры на основе каждой категории.
В следующей таблице показаны различные категории правил анализа кода и приведена ссылка на правила в каждой категории. Он также содержит значение конфигурации, используемое в файле EditorConfig для массовой настройки серьезности правил на основе каждой категории. Например, чтобы задать серьезность нарушений правил безопасности как ошибки, запись в EditorConfig будет dotnet_analyzer_diagnostic.category-Security.severity = error.
Подсказка
Установка серьезности для категории правил с помощью синтаксиса dotnet_analyzer_diagnostic.category-<category>.severity не применяется к правилам, отключенным по умолчанию. Однако начиная с .NET 6 можно использовать свойство проекта AnalysisMode<Category> , чтобы включить все правила в категории.
Правила проектирования
Правила документирования
|
Ценность |
|
Ссылка на правила |
Правила документации |
|
Описание |
Правила документации поддерживают написание хорошо документированных библиотек с помощью правильного использования комментариев xml-документации для внешних видимых API. |
|
Значение EditorConfig |
dotnet_analyzer_diagnostic.category-Documentation.severity |
|
Значение свойства MSBuild |
<AnalysisModeDocumentation> |
Правила глобализации
|
Ценность |
|
Ссылка на правила |
Правила глобализации |
|
Описание |
Правила глобализации поддерживают библиотеки и приложения, готовые к работе в глобальном масштабе. |
|
Значение EditorConfig |
dotnet_analyzer_diagnostic.category-Globalization.severity |
|
Значение свойства MSBuild |
<AnalysisModeGlobalization> |
Правила переносимости и взаимодействия
|
Ценность |
|
Ссылка на правила |
Правила переносимости и взаимодействия |
|
Описание |
Правила переносимости поддерживают переносимость на разных платформах. Правила взаимодействия поддерживают взаимодействие с COM-клиентами. |
|
Значение EditorConfig |
dotnet_analyzer_diagnostic.category-Interoperability.severity |
|
Значение свойства MSBuild |
<AnalysisModeInteroperability> |
Правила обслуживания
|
Ценность |
|
Ссылка на правила |
Правила обслуживания |
|
Описание |
Правила поддерживаемости поддерживают библиотеку и поддержку приложений. |
|
Значение EditorConfig |
dotnet_analyzer_diagnostic.category-Maintainability.severity |
|
Значение свойства MSBuild |
<AnalysisModeMaintainability> |
Правила именования
|
Ценность |
|
Ссылка на правила |
Правила именования |
|
Описание |
Правила именования поддерживают соблюдение соглашений об именовании рекомендаций по проектированию .NET. |
|
Значение EditorConfig |
dotnet_analyzer_diagnostic.category-Naming.severity |
|
Значение свойства MSBuild |
<AnalysisModeNaming> |
|
Ценность |
|
Ссылка на правила |
Правила производительности |
|
Описание |
Правила производительности поддерживают высокоэффективные библиотеки и приложения. |
|
Значение EditorConfig |
dotnet_analyzer_diagnostic.category-Performance.severity |
|
Значение свойства MSBuild |
<AnalysisModePerformance> |
Правила для SingleFile
|
Ценность |
|
Ссылка на правила |
Правила SingleFile |
|
Описание |
Правила однофайловых файлов поддерживают однофайловые приложения. |
|
Значение EditorConfig |
dotnet_analyzer_diagnostic.category-SingleFile.severity |
|
Значение свойства MSBuild |
<AnalysisModeSingleFile> |
Правила надежности
|
Ценность |
|
Ссылка на правила |
Правила надежности |
|
Описание |
Правила надежности поддерживают надежность библиотеки и приложений, например правильное использование памяти и потоков. |
|
Значение EditorConfig |
dotnet_analyzer_diagnostic.category-Reliability.severity |
|
Значение свойства MSBuild |
<AnalysisModeReliability> |
Правила безопасности
|
Ценность |
|
Ссылка на правила |
Правила безопасности |
|
Описание |
Правила безопасности поддерживают более безопасные библиотеки и приложения. Эти правила помогают предотвратить недостатки безопасности в программе. |
|
Значение EditorConfig |
dotnet_analyzer_diagnostic.category-Security.severity |
|
Значение свойства MSBuild |
<AnalysisModeSecurity> |
Правила стиля
|
Ценность |
|
Ссылка на правила |
Правила стиля |
|
Описание |
Правила стиля поддерживают согласованный стиль кода в базе кода. Эти правила начинаются с префикса интегрированной среды разработки.* |
|
Значение EditorConfig |
dotnet_analyzer_diagnostic.category-Style.severity |
|
Значение свойства MSBuild |
<AnalysisModeStyle> |
* Используйте значение dotnet_analyzer_diagnostic.category-CodeQuality.severity EditorConfig, чтобы включить следующие правила: IDE0051, IDE0052, IDE0064 и IDE0076. Хотя эти правила начинаются с "IDE", они не являются технической частью категории Style.
Правила использования
|
Ценность |
|
Ссылка на правила |
Правила использования |
|
Описание |
Правила использования поддерживают надлежащее использование .NET. |
|
Значение EditorConfig |
dotnet_analyzer_diagnostic.category-Usage.severity |
|
Значение свойства MSBuild |
<AnalysisModeUsage> |
