Linguagem e regras desnecessárias

As regras de estilo de código afetam como as várias construções das linguagens de programação .NET, por exemplo, modificadores e parênteses, são usadas.

Essa categoria também inclui regras que identificam partes da base do código que são desnecessárias e podem ser refatoradas ou removidas. A presença de código desnecessário indica um ou mais dos seguintes problemas:

• Legibilidade: um código que diminui desnecessariamente a legibilidade.
• Capacidade de manutenção: o código que não é mais usado após a refatoração e é mantido desnecessariamente.
• Desempenho: computação desnecessária que não tem efeitos colaterais e leva a sobrecarga de desempenho desnecessária.
• Funcionalidade: um problema funcional no código que torna redundante o código necessário. Por exemplo, IDE0060 sinaliza parâmetros não utilizados onde o método ignora acidentalmente um parâmetro de entrada.

As regras da linguagem se enquadram nas seguintes categorias:

• .NET regras de estilo: regras que se aplicam a C# e Visual Basic. Os nomes das opções para essas regras começam com o prefixo dotnet_style_.
• Regras de estilo C#: regras específicas do código C#. Os nomes das opções para essas regras começam com o prefixo csharp_style_.
• Regras de estilo do Visual Basic: regras específicas para o código Visual Basic. Os nomes das opções para essas regras começam com o prefixo visual_basic_style_.

Formato de opção

Muitas das regras da linguagem têm uma ou mais opções associadas para personalizar o estilo preferido. Por exemplo, Usar a declaração simples 'using' (IDE0063) tem a opção associada csharp_prefer_simple_using_statement que permite definir se você prefere uma declaração using ou uma declaração using. A regra aplica as opções que você escolher em um nível específico, por exemplo, aviso ou erro.

As opções para regras de idioma podem ser especificadas em um arquivo de configuração com o seguinte formato:

option_name = value (Visual Studio 2019 e posterior)

ou

option_name = value:severity

• Valor

  Para cada regra de linguagem, você especifica um valor que define se ou quando preferir o estilo. Muitas regras aceitam um valor de true (prefira este estilo) ou false (não prefira este estilo). Outras regras aceitam valores como when_on_single_line ou never.

• Severity (opcional em Visual Studio 2019 e versões posteriores)

  A segunda parte da regra especifica o nível de gravidade da regra. Em versões .NET 9 e posteriores, a gravidade é sempre respeitada, ou seja, nas IDEs de desenvolvimento e durante builds de linha de comando. Em .NET 8 e versões anteriores, essa configuração de severidade é respeitada apenas dentro de IDEs de desenvolvimento, como Visual Studio e not durante a compilação.

  Se você estiver usando o SDK do .NET 8 ou uma versão anterior e quiser que a gravidade seja respeitada no momento da compilação, você pode fazê-lo de duas maneiras:

  • Defina a propriedade <AnalysisLevel> ou <AnalysisLevelStyle> para 9.0 ou superior, ou para preview.
  • Ao invés disso, defina a severidade usando a sintaxe de configuração de severidade com base no ID da regra para os analisadores. A sintaxe assume o formato dotnet_diagnostic.<rule ID>.severity = <severity>, por exemplo, dotnet_diagnostic.IDE0040.severity = warning. Para obter mais informações, consulte nível de gravidade.

Índice de Regras

As regras de código desnecessárias e de linguagem são ainda categorizadas em subcategorias, como preferências de nível de expressão, preferências de bloco de código e preferências de modificador.

• usingpreferências de diretivas
• Preferências dos blocos de código
• Membros aptos para expressão
• Preferências de nível de expressão
• Preferências de campo
• Preferências de palavra-chave da linguagem vs. tipos de estrutura
• Preferências do modificador
• Preferências de nova linha
• Preferências de verificação nula
• Preferências de parâmetro
• Preferências de parênteses
• Preferências de reconhecimento de padrões
• Preferências de supressão
• preferências de This. e me.
• var preferências

using preferências de diretivas

.NET regras de estilo (C# e Visual Basic):

• Exigir cabeçalho de arquivo (IDE0073)

Regras de estilo do C#:

• Remover diretivas de uso desnecessário (IDE0005)
• Colocação da diretiva 'using' (IDE0065)

Preferências dos blocos de códigos

Regras de estilo do C#:

• Adicionar chaves (IDE0011)
• Usar a instrução 'using' simples (IDE0063)
• Preferências de declaração do namespace (IDE0160 e IDE0161)
• Remover a expressão lambda desnecessária (IDE0200)
• Converter para declarações de nível superior (IDE0210)
• Converter em programa no estilo 'Program.Main' (IDE0211)
• Usar construtor primário (IDE0290)
• Prefira 'System.Threading.Lock' (IDE0330)

Membros aptos para expressão

Regras de estilo do C#:

• Utilize corpo de expressão para construtores (IDE0021)
• Use o corpo da expressão para métodos (IDE0022)
• Usar corpo de expressão para operadores (IDE0023, IDE0024)
• Use o corpo da expressão para propriedades (IDE0025)
• Use um corpo de expressão para indexadores (IDE0026)
• Use o corpo da expressão para acessadores (IDE0027)
• Usar o corpo da expressão para lambdas (IDE0053)
• Use o corpo da expressão para funções locais (IDE0061)

Preferências de nível de expressão

.NET regras de estilo (C# e Visual Basic):

• Simplificar nome (IDE0001)
• Simplificar o acesso de membros (IDE0002)
• Remover a conversão desnecessária (IDE0004)
• Adicionar casos ausentes à instrução switch (IDE0010)
• Usar inicializadores de objeto (IDE0017)
• Usar inicializadores de coleção (IDE0028)
• A verificação de nulidade pode ser simplificada (IDE0029, IDE0030 e IDE0270)
• Usar propagação nula (IDE0031)
• Usar propriedade autoimplementada (IDE0032)
• Usar o nome de tupla fornecido explicitamente (IDE0033)
• Remover o código inacessível (IDE0035)
• Usar nomes de membros inferidos (IDE0037)
• Usar a verificação 'is null' (IDE0041)
• Usar expressão condicional para atribuição (IDE0045)
• Usar expressão condicional para retorno (IDE0046)
• Converter tipo anônimo em tupla (IDE0050)
• Remover membro privado não utilizado (IDE0051)
• Remover membro privado não utilizado (IDE0052)
• Usar a atribuição composta (IDE0054, IDE0074)
• Remover valor de expressão desnecessária (IDE0058)
• Remover a atribuição de valor desnecessária (IDE0059)
• Usar 'System.HashCode.Combine' (IDE0070)
• Simplificar a interpolação (IDE0071)
• Simplificar a expressão condicional (IDE0075)
• Converter typeof em nameof (IDE0082)
• Remover operador de igualdade desnecessário (IDE0100)
• Simplificar a expressão LINQ (IDE0120)
• Simplificar a verificação de tipo e conversão em LINQ (IDE0121)
• O namespace não corresponde à estrutura de pastas (IDE0130)

Regras de estilo do C#:

• Usar expressão throw (IDE0016)
• Declaração de variável embutida (IDE0018)
• Simplificar a expressão 'padrão' (IDE0034)
• Usar a função local em vez de lambda (IDE0039)
• Desconstruir declaração de variável (IDE0042)
• Usar o operador de índice (IDE0056)
• Usar operador de intervalo (IDE0057)
• Adicionar casos ausentes à expressão switch (IDE0072)
• Remover o operador de supressão desnecessário (IDE0080)
• Expressão new simplificada (IDE0090)
• Remover descarte desnecessário (IDE0110)
• Prefira a verificação 'null' à verificação de tipo (IDE0150)
• Usar tupla para trocar valores (IDE0180)
• Adicionar conversão explícita no loop foreach (IDE0220)
• Adicionar conversão explícita (IDE0221)
• Usar literal de cadeia de caracteres UTF-8 (IDE0230)
• A diretiva nullable é redundante (IDE0240)
• A diretiva nula é desnecessária (IDE0241)
• Usar expressão de coleção para matriz (IDE0300)
• Usar expressão de coleção para coleção vazia (IDE0301)
• Usar expressão de coleção para alocação de pilha (IDE0302)
• Usar expressão de coleção para Create() (IDE0303)
• Usar expressão de coleção para construtor (IDE0304)
• Usar expressão de coleção para sintaxe fluente (IDE0305)
• Use expressão de coleção para criação de novo objeto (IDE0306)
• Usar tipo genérico não associado (IDE0340)
• Usar lambda digitado implicitamente (IDE0350)
• Simplificar o acessador de propriedade (IDE0360)

Visual Basic regras de estilo:

• Remover ByVal (IDE0081)
• Usar correspondência de padrões (operador IsNot) (IDE0084)
• Simplificar a criação de objeto (IDE0140)

Preferências de campo

.NET regras de estilo (C# e Visual Basic):

• Adicionar modificador somente leitura (IDE0044)

Preferências de palavra-chave da linguagem versus tipos de estrutura

.NET regras de estilo (C# e Visual Basic):

• Usar palavras-chave de linguagem em vez de nomes de tipo de framework para referências de tipos (IDE0049)

Preferências do modificador

.NET regras de estilo (C# e Visual Basic):

• Modificadores de ordem (IDE0036)
• Adicionar modificadores de acessibilidade (IDE0040)

Regras de estilo do C#:

• Tornar a função local estática (IDE0062)
• Tornar campos de struct editáveis (IDE0064)
• O struct pode ser declarado como "readonly" (IDE0250)
• O membro pode ser feito "readonly" (IDE0251)
• Faça a função anônima ser estática (IDE0320)
• Remover modificador desnecessário unsafe (IDE0380)

preferências de nova linha

.NET regras de estilo (C# e Visual Basic):

• Evite várias linhas em branco (IDE2000)†
• Linha em branco necessária entre o bloco e a instrução subsequente (IDE2003)†

Regras de estilo do C#:

• As instruções inseridas devem estar em sua própria linha (IDE2001)†
• Chaves consecutivas não devem ter linha em branco entre elas (IDE2002)†
• Linha em branco não permitida após os dois-pontos do inicializador de construtor (IDE2004)
• Linha em branco não permitida após token de expressão condicional (IDE2005)†
• Linha em branco não permitida após o token da cláusula de expressão de seta (IDE2006)†

†As regras são experimentais e estão sujeitas a alterações ou remoção.

Preferências de verificação nula

Regras de estilo do C#:

• Usar chamada de delegado condicional (IDE1005)

Preferências de parâmetro

.NET regras de estilo (C# e Visual Basic):

• Remover parâmetro não utilizado (IDE0060)
• Use "nameof" (IDE0280)

Preferências de parênteses

.NET regras de estilo (C# e Visual Basic):

• Preferências de parênteses (IDE0047, IDE0048)

Configurações de correspondência de padrões

Regras de estilo do C#:

• Utilize a correspondência de padrões para evitar a verificação "as" seguida de "null" (IDE0019)
• Usar padrões correspondentes para evitar a verificação 'is' seguida por uma conversão (IDE0020, IDE0038)
• Usar a expressão switch (IDE0066)
• Utilizar correspondência de padrões (IDE0078 e IDE0260)
• Usar correspondência de padrões (operador not) (IDE0083)
• Simplificar o padrão de propriedade (IDE0170)

Preferências de supressão

.NET regras de estilo (C# e Visual Basic):

• Remover a supressão desnecessária (IDE0079)

Regras de estilo do C#:

• Remover supressão desnecessária (operador que permite nulo) (IDE0370)

This. e me. preferências

.NET regras de estilo (C# e Visual Basic):

• Preferências de qualificação de acesso dos membros (IDE0003 e IDE0009)

var preferências

Regras de estilo do C#:

• preferências de 'var' (IDE0007, IDE0008)

Confira também

• referência das regras de estilo de código .NET