Предпочтения var (IDE0007 и IDE0008)

Статья
06/08/2023

В этой статье описываются два связанных правила: IDE0007 и IDE0008.

Свойство	Значение
Идентификатор правила	IDE0007
Заголовок	Использование `var` вместо явного типа
Категория	Стиль
Подкатегория	Языковые правила (параметры var)
Применимые языки	C#
Параметры	`csharp_style_var_for_built_in_types`
	`csharp_style_var_when_type_is_apparent`
	`csharp_style_var_elsewhere`

Свойство	Значение
Идентификатор правила	IDE0008
Заголовок	Использование явного типа вместо `var`
Категория	Стиль
Подкатегория	Языковые правила (параметры var)
Применимые языки	C#
Параметры	`csharp_style_var_for_built_in_types`
	`csharp_style_var_when_type_is_apparent`
	`csharp_style_var_elsewhere`

Общие сведения

Эти два правила стиля определяют, следует ли использовать тип var ключевое слово или явный тип в объявлении переменной. Чтобы применить var этот параметр, задайте для параметра серьезность IDE0007 предупреждение или ошибка. Чтобы принудительно использовать явный тип, задайте для параметра серьезность IDE0008 предупреждения или ошибки.

Варианты

Связанные с этим правилом параметры определяют, где следует применять этот стиль:

Встроенные типы (csharp_style_var_for_built_in_types)
Места, где тип является очевидным (csharp_style_var_when_type_is_apparent)
В другом месте (csharp_style_var_elsewhere)

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

csharp_style_var_for_built_in_types

Свойство	Значение	Описание
Имя параметра	csharp_style_var_for_built_in_types
Значения параметра	`true`	Предпочтительно `var` используется для объявления переменных со встроенными системными типами, такими как `int`
	`false`	Предпочитать явный тип вместо `var` объявления переменных со встроенными системными типами, такими как `int`
Значение параметра по умолчанию	`false`

// csharp_style_var_for_built_in_types = true
var x = 5;

// csharp_style_var_for_built_in_types = false
int x = 5;

csharp_style_var_when_type_is_apparent

Свойство	Значение	Описание
Имя параметра	csharp_style_var_when_type_is_apparent
Значения параметра	`true`	Предпочитать `var` , если тип уже упоминается в правой части выражения объявления
	`false`	Предпочитать явный тип, если тип уже указан в правой части выражения объявления
Значение параметра по умолчанию	`false`

// csharp_style_var_when_type_is_apparent = true
var obj = new Customer();

// csharp_style_var_when_type_is_apparent = false
Customer obj = new Customer();

csharp_style_var_elsewhere

Свойство	Значение	Описание
Имя параметра	csharp_style_var_elsewhere
Значения параметра	`true`	Предпочитать `var` явный тип во всех случаях, если не переопределен другим правилом стиля кода
	`false`	Предпочитать явный тип `var` во всех случаях, если не переопределен другим правилом стиля кода
Значение параметра по умолчанию	`false`

// csharp_style_var_elsewhere = true
var f = this.Init();

// csharp_style_var_elsewhere = false
bool f = this.Init();

Отключение предупреждений

Если вы хотите отключить только одно нарушение, добавьте директивы препроцессора в исходный файл, чтобы отключить и снова включить правило.

#pragma warning disable IDE0007 // Or IDE0008
// The code that's violating the rule is on this line.
#pragma warning restore IDE0007 // Or IDE0008

Чтобы отключить правило для файла, папки или проекта, присвойте ей значение серьезности none в файле конфигурации.

[*.{cs,vb}]
dotnet_diagnostic.IDE0007.severity = none
dotnet_diagnostic.IDE0008.severity = none

Чтобы отключить все правила в стиле кода, задайте серьезность для категории Stylenone в файле конфигурации.

[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none

Дополнительные сведения см. в разделе Практическое руководство. Скрытие предупреждений анализа кода.