Параметры конфигурации для правил качества кода

2025-06-06

Правила качества кода имеют дополнительные параметры конфигурации помимо настройки серьезности. Например, каждый анализатор качества кода можно применять только к отдельным частям базы кода. Эти параметры задаются в формате пар "ключ — значение" в том же файле EditorConfig, где и уровни серьезности для правил и общие параметры редактора.

Примечание.

В этой статье нет сведений о настройке серьезности правила. Параметр .editorconfig для задания серьезности правила имеет другой префикс () для описанных здесь параметров (). Кроме того, описанные здесь параметры относятся только к правилам качества кода, в то время как параметр серьезности также применяется к правилам стиля кода. В качестве краткой ссылки можно настроить серьезность правила с помощью следующего синтаксиса параметра:

dotnet_diagnostic.<rule ID>.severity = <severity value>

Однако подробные сведения о настройке серьезности правил см . на уровне серьезности.

Области параметров

Каждый параметр уточнения можно задать для всех правил, для определенной категории (например, безопасности или проектирования) или для конкретного правила.

Все правила

Следующий синтаксис позволяет применить параметр для всех правил:

Синтаксис	Пример
dotnet_code_quality.<OptionName> = <OptionValue>	`dotnet_code_quality.api_surface = public`

Значения для <OptionName> указаны в разделе Параметры.

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

Следующий синтаксис позволяет применить параметр для одной категории правил:

Синтаксис	Пример
dotnet_code_quality.<RuleCategory>.<OptionName> = OptionValue	`dotnet_code_quality.Naming.api_surface = public`

В следующей таблице перечислены доступные значения для <RuleCategory>.

Design
Documentation
Globalization
Interoperability

Maintainability
Naming
Performance
SingleFile

Reliability
Security
Usage

Конкретное правило

Следующий синтаксис позволяет применить параметр для конкретного правила:

Синтаксис	Пример
dotnet_code_quality.<RuleId>.<OptionName> = <OptionValue>	`dotnet_code_quality.CA1040.api_surface = public`