Preferências "var" (IDE0007 e IDE0008)

Artigo
06/08/2023

Este artigo descreve duas regras IDE0007 relacionadas e IDE0008.

Propriedade	Valor
ID da Regra	IDE0007
Título	Utilizar `var` em vez de tipo explícito
Categoria	Estilo
Subcategoria	Regras de idioma (preferências de var)
Idiomas aplicáveis	C#
Opções	`csharp_style_var_for_built_in_types`
	`csharp_style_var_when_type_is_apparent`
	`csharp_style_var_elsewhere`

Propriedade	Valor
ID da Regra	IDE0008
Título	Utilizar o tipo explícito em vez de `var`
Categoria	Estilo
Subcategoria	Regras de idioma (preferências de var)
Idiomas aplicáveis	C#
Opções	`csharp_style_var_for_built_in_types`
	`csharp_style_var_when_type_is_apparent`
	`csharp_style_var_elsewhere`

Descrição Geral

Estas duas regras de estilo definem se a palavra-chave var ou um tipo explícito deve ser utilizado numa declaração de variável. Para impor que var é utilizado, defina a gravidade de IDE0007 para aviso ou erro. Para impor que o tipo explícito é utilizado, defina a gravidade de IDE0008 para aviso ou erro.

Opções

As opções associadas desta regra definem onde esta preferência de estilo deve ser aplicada:

Tipos incorporados (csharp_style_var_for_built_in_types)
Locais onde o tipo é aparente (csharp_style_var_when_type_is_apparent)
Noutros locais (csharp_style_var_elsewhere)

Para obter mais informações sobre como configurar opções, veja Formato de opção.

csharp_style_var_for_built_in_types

Propriedade	Valor	Descrição
Nome da opção	csharp_style_var_for_built_in_types
Valores de opção	`true`	A preferência `var` é utilizada para declarar variáveis com tipos de sistema incorporados, como `int`
	`false`	Preferir o tipo explícito em vez `var` de declarar variáveis com tipos de sistema incorporados, como `int`
Valor de opção predefinido	`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

Propriedade	Valor	Descrição
Nome da opção	csharp_style_var_when_type_is_apparent
Valores de opção	`true`	Preferir `var` quando o tipo já está mencionado no lado direito de uma expressão de declaração
	`false`	Preferir o tipo explícito quando o tipo já é mencionado no lado direito de uma expressão de declaração
Valor de opção predefinido	`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

Propriedade	Valor	Descrição
Nome da opção	csharp_style_var_elsewhere
Valores de opção	`true`	Prefira `var` o tipo explícito em todos os casos, a menos que seja substituído por outra regra de estilo de código
	`false`	Preferir o tipo `var` explícito em todos os casos, a menos que seja substituído por outra regra de estilo de código
Valor de opção predefinido	`false`

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

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

Suprimir um aviso

Se quiser suprimir apenas uma única violação, adicione diretivas de pré-processamento ao ficheiro de origem para desativar e, em seguida, reativar a regra.

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

Para desativar a regra de um ficheiro, pasta ou projeto, defina a gravidade para none no ficheiro de configuração.

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

Para desativar todas as regras de estilo de código, defina a gravidade da categoria Style como none no ficheiro de configuração.

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

Para obter mais informações, veja Como suprimir avisos de análise de código.