CA1508: Evitar código condicional morto

Artigo
06/01/2023

Property	Valor
ID da regra	CA1508
Título	Evitar código condicional morto
Categoria	Facilidade de manutenção
Correção interruptiva ou sem interrupção	Sem interrupção
Habilitado por padrão no .NET 9	Não

Causa

Um método tem um código condicional que é sempre avaliado para true ou false no runtime. Isso leva a um código morto na ramificação false da condição.

Por padrão, essa regra analisa toda a base de código, mas isso é configurável.

Descrição da regra

Os métodos podem ter código condicional, como instruções if, expressões binárias (==, !=, <, >), verificações nulas etc. Por exemplo, considere o seguinte código:

public void M(int i, int j)
{
    if (i != 0)
    {
        return;
    }

    if (j != 0)
    {
        return;
    }

    // Below condition will always evaluate to 'false' as 'i' and 'j' are both '0' here.
    if (i != j)
    {
        // Code in this 'if' branch is dead code.
        // It can either be removed or refactored.
        ...
    }
}

Os compiladores C# e VB realizam análises de verificações condicionais envolvendo valores constantes em tempo de compilação que sempre avaliam como true ou false. Este analisador executa a análise de fluxo de dados de variáveis não constantes para determinar verificações condicionais redundantes envolvendo valores não constantes. No código anterior, o analisador determina que i e j são ambos 0 para todos os caminhos de código que atingem a verificação i != j. Portanto, essa verificação sempre será avaliada como false em tempo de execução. O código dentro da instrução if está morto e pode ser removido ou refatorado. Da mesma forma, o analisador rastreia a nulidade de variáveis e relata verificações de nulo redundantes.

Observação

Este analisador executa uma análise cara de fluxo de dados de valores não constantes. Isso pode aumentar o tempo de compilação geral em determinadas bases de código.

Quando suprimir avisos

Será seguro suprimir uma violação dessa regra se você não estiver preocupado com a manutenção do código. Também não há problema em suprimir violações identificadas como falsos positivos. Isso é possível na presença de código simultâneo que pode ser executado a partir de vários threads.

Suprimir um aviso

Para suprimir apenas uma violação, adicione diretivas de pré-processador ao arquivo de origem a fim de desabilitar e, em seguida, reabilitar a regra.

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

Para desabilitar a regra em um arquivo, uma pasta ou um projeto, defina a severidade como none no arquivo de configuração.

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

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

Configurar código para analisar

Use as opções a seguir para configurar em quais partes da base de código essa regra deve ser executada.

Excluir símbolos específicos
Excluir tipos específicos e seus tipos derivados

Você pode configurar essas opções apenas para essa regra, para todas as regras às quais ela se aplica ou para todas as regras nessa categoria (Capacidade de manutenção) às quais ela se aplica. Para saber mais, confira Opções de configuração de regra de qualidade de código.

Excluir símbolos específicos

Você pode excluir da análise símbolos específicos, como tipos e métodos. Por exemplo, para especificar que a regra não deve ser executada em nenhum código dentro de tipos nomeados MyType, adicione o seguinte par chave-valor a um arquivo .editorconfig no seu projeto:

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

Formatos de nome de símbolo permitidos no valor da opção (separados por |):

Somente nome do símbolo (inclui todos os símbolos com o nome, independentemente do tipo ou namespace que contém).
Nomes totalmente qualificados no formato de ID de documentação do símbolo. Cada nome de símbolo requer um prefixo do tipo símbolo, como M: para métodos, T: para tipos e N: para namespaces.
.ctor para construtores e .cctor para construtores estáticos.

Exemplos:

Valor de Opção	Resumo
`dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType`	Corresponde a todos os símbolos nomeados `MyType`.
`dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType1\|MyType2`	Corresponde a todos os símbolos nomeados `MyType1` ou `MyType2`.
`dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS.MyType.MyMethod(ParamType)`	Corresponde ao método `MyMethod` específico com a assinatura totalmente qualificada especificada.
`dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS1.MyType1.MyMethod1(ParamType)\|M:NS2.MyType2.MyMethod2(ParamType)`	Corresponde aos métodos `MyMethod1` e `MyMethod2` específico com as assinaturas respectivas totalmente qualificadas.

Excluir tipos específicos e seus tipos derivados

Você pode excluir tipos específicos e seus tipos derivados da análise. Por exemplo, para especificar que a regra não deve ser executada em nenhum método dentro de tipos nomeados MyType e seus tipos derivados, adicione o seguinte par chave-valor a um arquivo .editorconfig no seu projeto:

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType