CA1508: Evitar código condicional inativo

Artigo
09/06/2023

Property	valor
ID da regra	CA1508
Título	Evite código condicional inativo
Categoria	Manutenibilidade
A correção está quebrando ou não quebrando	Não-quebrando
Habilitado por padrão no .NET 8	Não

Motivo

Um método tem código condicional que sempre é avaliado para true ou false em tempo de execução. Isso leva ao código morto no false ramo 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 para 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 e j são ambos 0 para todos os caminhos de código que i alcançam i != j a verificação. Assim, esta verificação será sempre avaliada em tempo de false execução. O código dentro da instrução if é código morto e pode ser removido ou refatorado. Da mesma forma, o analisador rastreia a nulidade de variáveis e relata verificações nulas redundantes.

Nota

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

Quando suprimir avisos

É seguro suprimir uma violação dessa regra se você não estiver preocupado com a capacidade de manutenção do seu código. Também é bom suprimir violações que são identificadas como falsos positivos. Estes são possíveis na presença de código simultâneo que pode ser executado a partir de vários threads.

Suprimir um aviso

Se você quiser apenas suprimir uma única violação, adicione diretivas de pré-processador ao seu arquivo de origem para desativar e, em seguida, reativar 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 de um arquivo, pasta ou projeto, defina sua gravidade como none no arquivo de configuração.

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

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

Configurar código para análise

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

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

Você pode configurar essas opções apenas para esta regra, para todas as regras às quais ela se aplica ou para todas as regras nesta categoria (Manutenabilidade) às quais ela se aplica. Para obter mais informações, consulte Opções de configuração da regra de qualidade de código.

Excluir símbolos específicos

Você pode excluir símbolos específicos, como tipos e métodos, da análise. 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 em 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 o contém).
Nomes totalmente qualificados no formato de ID de documentação do símbolo. Cada nome de símbolo requer um prefixo de tipo de 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 da opção	Resumo
`dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType`	Corresponde a todos os símbolos denominados `MyType`.
`dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType1\|MyType2`	Corresponde a todos os símbolos denominados ou `MyType1MyType2`.
`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 a métodos `MyMethod1` específicos e `MyMethod2` com as respetivas assinaturas 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 em seu projeto:

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType