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

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

Примечание.

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

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

Параметры

В этом разделе приведены некоторые из доступных параметров. Полный список доступных параметров см. на странице Analyzer Configuration (Конфигурация анализатора).

• api_surface
• exclude_async_void_methods
• exclude_single_letter_type_parameters
• output_kind
• required_modifiers
• exclude_extension_method_this_parameter
• null_check_validation_methods
• additional_string_formatting_methods
• excluded_type_names_with_derived_types
• excluded_symbol_names
• disallowed_symbol_names
• exclude_ordefault_methods
• ignore_internalsvisibleto
• try_determine_additional_string_formatting_methods_automatically
• unsafe_DllImportSearchPath_bits
• exclude_aspnet_core_mvc_controllerbase
• dispose_analysis_kind
• dispose_ownership_transfer_at_constructor
• dispose_ownership_transfer_at_method_call
• enum_values_prefix_trigger
• exclude_indirect_base_types
• additional_required_suffixes
• additional_required_generic_interfaces
• additional_inheritance_excluded_symbol_names
• analyzed_symbol_kinds
• use_naming_heuristic
• additional_use_results_methods
• allowed_suffixes
• enable_platform_analyzer_on_pre_net5_target
• exclude_structs
• additional_enum_none_names
• enumeration_methods
• linq_chain_methods
• assume_method_enumerates_parameters

api_surface

Description	Допустимые значения	Default value	Настраиваемые правила
Какая часть поверхности API будет анализироваться	public (применяется к public и protected API) internal или friend (применяется к internal API и private protected api) private (применимо к private API) all (применяется ко всем API) Для разделения значений используйте запятые (,)	public	CA1000 CA1002 CA1003 CA1005 CA1008 CA1010 CA1012 CA1021 CA1024 CA1027 CA1028 CA1030 CA1030 CA1036 CA1040 CA1041 CA1043 CA1044 CA1045 CA1046 CA1047 CA1051 CA1052 CA1054 CA1055 CA1056 CA1058 CA1062 CA1063 CA1068 CA1070 CA1700 CA1707 CA1708 CA1710 CA1711 CA1714 CA1715 CA1716 CA1716 CA1717 CA1720 CA1721 CA1725 CA1801 CA1802 CA1815 CA1819 CA1822 CA1859 CA2208 CA2217 CA22225 CA2226 CA2231 CA2234

exclude_async_void_methods

Description	Допустимые значения	Default value	Настраиваемые правила
Нужно ли игнорировать асинхронные методы, которые не возвращают значений	true false	false	CA2007

Примечание.

Этот параметр именовался skip_async_void_methods в более ранней версии.

exclude_single_letter_type_parameters

Description	Допустимые значения	Default value	Настраиваемые правила
Нужно ли исключать из правила односимвольные параметры типа, как например S в Collection<S>	true false	false	CA1715

Примечание.

Этот параметр именовался allow_single_letter_type_parameters в более ранней версии.

output_kind

Description	Допустимые значения	Default value	Настраиваемые правила
Указывает, что нужно анализировать код в проекте, который создает сборку указанного типа	Одно или несколько полей перечисления OutputKind Для разделения значений используйте запятые (,)	Все типы выходных данных	CA2007

required_modifiers

Description	Допустимые значения	Default value	Настраиваемые правила
Указывает обязательные модификаторы для API, которые нужно анализировать	Одно или несколько значений из приведенной ниже таблицы допустимых модификаторов Для разделения значений используйте запятые (,)	Зависит от конкретного правила	CA1802

Допустимый модификатор	Итоги
none	Нет требований к модификатору
static или Shared	Должен быть объявлен как static (или Shared в Visual Basic)
const	Должен быть объявлен как const
readonly	Должен быть объявлен как readonly
abstract	Должен быть объявлен как abstract
virtual	Должен быть объявлен как virtual
override	Должен быть объявлен как override
sealed	Должен быть объявлен как sealed
extern	Должен быть объявлен как extern
async	Должен быть объявлен как async

exclude_extension_method_this_parameter

Description	Допустимые значения	Default value	Настраиваемые правила
Нужно ли пропускать анализ для параметра this в методах расширения	true false	false	CA1062

null_check_validation_methods

Description	Допустимые значения	Default value	Настраиваемые правила
Имена методов проверки на значение NULL, которые проверяют отсутствие значений NULL в аргументах, передаваемых в метод	Форматы имен разрешенных методов (разделенные |): — только имя метода (включает все методы с этим именем, любого типа и в любом пространстве имен); — полные имена в формате идентификатора документации для символа с необязательным префиксом M:.	нет	CA1062

additional_string_formatting_methods

Description	Допустимые значения	Default value	Настраиваемые правила
Имена дополнительных методов форматирования строк	Форматы имен разрешенных методов (разделенные |): — только имя метода (включает все методы с этим именем, любого типа и в любом пространстве имен); — полные имена в формате идентификатора документации для символа с необязательным префиксом M:.	нет	CA2241

excluded_type_names_with_derived_types

Description	Допустимые значения	Default value	Настраиваемые правила
Имена типов (включая все производные типы), исключаемых из анализа	Допустимые форматы имен символов (разделенные |): — только имя типа (включает все типы с этим именем, любого типа и в любом пространстве имен); — полные имена в формате идентификатора документации для символа с необязательным префиксом T:.	нет	CA1001 CA1054 CA1055 CA1056 CA1062 CA1068 CA1303 CA1304 CA1305 CA1508 CA2000 CA2100 CA2301 CA2302 CA2311 CA2312 CA2321 CA2322 CA2327 CA2328 CA2329 CA2330 CA3001 CA3002 CA3003 CA3004 CA3005 CA3006 CA3007 CA3008 CA3009 CA3010 CA3011 CA3012 CA5361 CA5376 CA5377 CA5377 CA5378 CA5380 CA5381 CA5382 CA5383 CA5384 CA5387 CA5388 CA5389 CA5390 CA5399 CA5399 CA5400

excluded_symbol_names

Description	Допустимые значения	Default value	Настраиваемые правила
Имена символов, исключаемых из анализа	Допустимые форматы имен символов (разделенные |): — только имя символа (включает все символы с этим именем, любого типа и в любом пространстве имен); — полные имена в формате идентификатора документации для символа. Для каждого имени символа требуется префикс вида символа, например префикс M: для методов, префикс T: для типов и префикс N: для пространств имен. - .ctor используется для конструкторов, а .cctor — для статических конструкторов	нет	CA1001 CA1054 CA1055 CA1056 CA1062 CA1068 CA1303 CA1304 CA1305 CA1508 CA2000 CA2100 CA2301 CA2302 CA2311 CA2312 CA2321 CA2322 CA2327 CA2328 CA2329 CA2330 CA3001 CA3002 CA3003 CA3004 CA3005 CA3006 CA3007 CA3008 CA3009 CA3010 CA3011 CA3012 CA5361 CA5376 CA5377 CA5377 CA5378 CA5380 CA5381 CA5382 CA5383 CA5384 CA5387 CA5388 CA5389 CA5390 CA5399 CA5399 CA5400

disallowed_symbol_names

Description	Допустимые значения	Default value	Настраиваемые правила
Имена символов, запрещенных в контексте анализа	Допустимые форматы имен символов (разделенные |): — только имя символа (включает все символы с этим именем, любого типа и в любом пространстве имен); — полные имена в формате идентификатора документации для символа. Для каждого имени символа требуется префикс вида символа, например префикс M: для методов, префикс T: для типов и префикс N: для пространств имен. - .ctor используется для конструкторов, а .cctor — для статических конструкторов	нет	CA1031

exclude_ordefault_methods

Description	Допустимые значения	Default value	Настраиваемые правила
FirstOrDefault Исключает и LastOrDefault методы из анализа.	true или false	false	CA1826

ignore_internalsvisibleto

Description	Допустимые значения	Default value	Настраиваемые правила
Включает сборки, InternalsVisibleToAttribute помеченные в анализе.	true или false	true	CA1812 CA1852

try_determine_additional_string_formatting_methods_automatically

Description	Допустимые значения	Default value	Настраиваемые правила
Логический параметр для включения эвристического обнаружения дополнительных методов форматирования строк. Метод считается методом форматирования строк, если он имеет string format параметр, за которым следует params object[] параметр.	true или false	false	CA2241

unsafe_DllImportSearchPath_bits

Description	Допустимые значения	Default value	Настраиваемые правила
Настройка небезопасного значения DllImportSearchPath для анализа	Целочисленные значения System.Runtime.InteropServices.DllImportSearchPath	770 (т. AssemblyDirectory | UseDllDirectoryForDependencies | ApplicationDirectoryе. )	CA5393

exclude_aspnet_core_mvc_controllerbase

Description	Допустимые значения	Default value	Настраиваемые правила
Исключение ASP.NET Core MVC ControllerBase при рассмотрении CSRF	true или false	true	CA5391

dispose_analysis_kind

Description	Допустимые значения	Default value	Настраиваемые правила
Указывает, какие пути для анализа для удаления нарушений	- AllPaths — отслеживайте и сообщайте о отсутствующих нарушениях по всем путям (не исключениям и путям исключений). Кроме того, также помечайте использование нерекоменционных шаблонов удаления, которые могут вызвать потенциальные утечки удаления. - AllPathsOnlyNotDisposed — отслеживайте и сообщайте о отсутствующих нарушениях по всем путям (не исключениям и путям исключений). Не отмечайте использование нерекоменционных шаблонов удаления, которые могут вызвать потенциальные утечки удаления. - NonExceptionPaths — отслеживайте и сообщайте о отсутствующих нарушениях только в путях программы, отличных от исключений. Кроме того, также помечайте использование нерекоменционных шаблонов удаления, которые могут вызвать потенциальные утечки удаления. - NonExceptionPathsOnlyNotDisposed — отслеживайте и сообщайте о отсутствующих нарушениях только в путях программы, отличных от исключений. Не отмечайте использование нерекоменционных шаблонов удаления, которые могут вызвать потенциальные утечки удаления.	NonExceptionPaths	CA2000

dispose_ownership_transfer_at_constructor

Description	Допустимые значения	Default value	Настраиваемые правила
Настройка передачи права владения для аргументов, переданных в вызов конструктора	true или false	false	CA2000

dispose_ownership_transfer_at_method_call

Description	Допустимые значения	Default value	Настраиваемые правила
Настройка передачи права владения для удаленных объектов, переданных в качестве аргументов в вызовы методов	true или false	false	CA2000

enum_values_prefix_trigger

Description	Допустимые значения	Default value	Настраиваемые правила
Задает пороговое значение для активации правила именования значений перечисления	- AnyEnumValue — правило активируется, если любое из значений перечисления начинается с имени типа перечисления. - AllEnumValues — правило активируется, если все значения перечисления начинаются с имени типа перечисления. - Heuristic — Правило активируется с помощью эвристики FxCop по умолчанию (то есть, если не менее 75% значений перечисления начинаются с имени типа перечисления).	Heuristic	CA1712

exclude_indirect_base_types

Description	Допустимые значения	Default value	Настраиваемые правила
Исключить косвенные базовые типы	true или false	true	CA1710

additional_required_suffixes

Description	Допустимые значения	Default value	Настраиваемые правила
Указывает дополнительные необходимые суффиксы	Список имен типов (разделенных |) с обязательным суффиксом (разделенным).-> Форматы имен разрешенного типа: — только имя типа (включает все типы с именем, независимо от содержащего типа или пространства имен). — Полные имена в формате идентификатора документации символа с необязательным T: префиксом.	нет	CA1710

additional_required_generic_interfaces

Description	Допустимые значения	Default value	Настраиваемые правила
Указывает дополнительные обязательные универсальные интерфейсы	Список имен интерфейсов (разделенных |) с обязательным универсальным полным интерфейсом (разделенным).-> Допустимые форматы интерфейса: — только имя интерфейса (включает все интерфейсы с именем, независимо от типа или пространства имен). — Полные имена в формате идентификатора документации символа с необязательным T: префиксом.	нет	CA1010

Примеры:

Значение параметра	Итоги
dotnet_code_quality.CA1010.additional_required_generic_interfaces = ISomething->System.Collections.Generic.IEnumerable`1	Все типы, реализующие ISomething независимо от его пространства имен, должны также реализовываться System.Collections.Generic.IEnumerable\`1.
dotnet_code_quality.CA1010.additional_required_generic_interfaces = T:System.Collections.IDictionary->T:System.Collections.Generic.IDictionary`2	Ожидается, что все типы, реализующие System.Collections.IDictionary , также будут реализованы System.Collections.Generic.IDictionary`2.

additional_inheritance_excluded_symbol_names

Description	Допустимые значения	Default value	Настраиваемые правила
Указывает типы или пространства имен, которые следует исключить из дерева иерархии наследования	Форматы имен разрешенного типа: — имя типа или пространства имен (включает все типы с именем, независимо от содержащего типа или пространства имен, а также всех типов, пространство имен которых содержит имя). — Имя типа или пространства имен, заканчивающееся подстановочным знаком (включает все типы, имя которых начинается с заданного имени, независимо от содержащего типа или пространства имен, и всех типов, пространство имен которых содержит имя). — Полные имена в формате идентификатора документации символа с необязательным T: префиксом для типов или N: префиксов для пространств имен. — Полный тип или имя пространства имен с необязательным T: префиксом типа или N: префикса для пространства имен и заканчивая символом подстановочного знака (включает все типы, полное имя которого начинается с заданного имени типа, или все типы, полное имя которого начинается с заданного имени пространства имен).	N:System.* (Это значение всегда автоматически добавляется в указанное значение)	CA1501

analyzed_symbol_kinds

Description	Допустимые значения	Default value	Настраиваемые правила
Указывает типы символов для анализа	Одно или несколько полей в виде разделенного запятыми SymbolKind списка.	Namespace, NamedType, Method, Property, Event, Parameter	CA1716

use_naming_heuristic

Description	Допустимые значения	Default value	Настраиваемые правила
Определяет, содержатся ли параметры или имена свойств, содержащие Text, Messageили Caption активировать это правило.	true или false	false	CA1303

additional_use_results_methods

Description	Допустимые значения	Default value	Настраиваемые правила
Указывает дополнительные пользовательские API, результаты которых должны использоваться	Имена дополнительных методов (разделенные |). Форматы разрешенных имен метода: — только имя метода (включает все методы с именем, независимо от содержащего типа или пространства имен). — Полные имена в формате идентификатора документации символа с необязательным M: префиксом.	нет	CA1806

allowed_suffixes

Description	Допустимые значения	Default value	Настраиваемые правила
Указывает допустимые суффиксы	Список (разделенный |) разрешенных суффиксов.	нет	CA1711

enable_platform_analyzer_on_pre_net5_target

Description	Допустимые значения	Default value	Настраиваемые правила
Указывает, следует ли включить анализ для TFM до .NET 5	true или false	false	CA1416

exclude_structs

Description	Допустимые значения	Default value	Настраиваемые правила
Указывает, следует ли исключить структуры из анализа	true или false	false	CA1051

additional_enum_none_names

Description	Допустимые значения	Default value	Настраиваемые правила
Задает дополнительные допустимые имена для поля перечисления нулевого значения	Список дополнительных имен (разделенных |).	нет	CA1008

enumeration_methods

Description	Допустимые значения	Default value	Настраиваемые правила
Указывает дополнительные пользовательские методы, перечисляющие IEnumerable	Полные имена дополнительных методов (разделенные |).	нет	CA1851

linq_chain_methods

Description	Допустимые значения	Default value	Настраиваемые правила
Указывает дополнительные настраиваемые методы LINQ chain (т. е. методы принимают IEnumerable аргумент и возвращают новый IEnumerable экземпляр).	Полные имена дополнительных методов (разделенные |).	нет	CA1851

assume_method_enumerates_parameters

Description	Допустимые значения	Default value	Настраиваемые правила
Указывает, следует ли предполагать, что настраиваемые методы перечисляют их IEnumerable параметры	true или false	false	CA1851