CA1508: Evitare codice condizionale non morto

Articolo
11/12/2024

Proprietà	valore
ID regola	CA1508
Title	Evitare codice di condizione non utilizzato
Categoria	Manutenibilità
La correzione causa un'interruzione o meno	Nessuna interruzione
Abilitato per impostazione predefinita in .NET 9	No

Causa

Un metodo ha codice condizionale che restituisce true sempre o false in fase di esecuzione. In questo modo si verifica un false codice inattivo nel ramo della condizione.

Per impostazione predefinita, questa regola analizza l'intera codebase, ma è configurabile.

Descrizione regola

I metodi possono avere codice condizionale, ad esempio istruzioni if, espressioni binarie (==, <!=, , >), controlli Null e così via. Si consideri ad esempio il codice seguente:

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.
        ...
    }
}

I compilatori C# e VB eseguono l'analisi dei controlli condizionali che includono valori costanti in fase di compilazione che restituiscono true sempre o false. Questo analizzatore esegue l'analisi del flusso di dati di variabili non costanti per determinare controlli condizionali ridondanti che coinvolgono valori non costanti. Nel codice precedente, l'analizzatore determina che i e sono entrambi 0 per tutti i percorsi di codice che raggiungono i != j il j controllo. Di conseguenza, questo controllo restituirà false sempre in fase di esecuzione. Il codice all'interno dell'istruzione if è inattivo e può essere rimosso o sottoposto a refactoring. Analogamente, l'analizzatore tiene traccia dell'nullità delle variabili e segnala controlli Null ridondanti.

Nota

Questo analizzatore esegue un'analisi costosa del flusso di dati di valori non costanti. Ciò può aumentare il tempo di compilazione complessivo in determinate codebase.

Quando eliminare gli avvisi

È possibile eliminare una violazione di questa regola se non si è preoccupati per la manutenibilità del codice. È anche bene eliminare le violazioni identificate come falsi positivi. Sono possibili in presenza di codice simultaneo che può essere eseguito da più thread.

Eliminare un avviso

Se si vuole eliminare una singola violazione, aggiungere direttive del preprocessore al file di origine per disabilitare e quindi riabilitare la regola.

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

Per disabilitare la regola per un file, una cartella o un progetto, impostarne la gravità none su nel file di configurazione.

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

Per altre informazioni, vedere Come eliminare gli avvisi di analisi del codice.

Configurare il codice da analizzare

Usare le opzioni seguenti per configurare le parti della codebase in cui eseguire questa regola.

Escludere simboli specifici
Escludere tipi specifici e i relativi tipi derivati

È possibile configurare queste opzioni solo per questa regola, per tutte le regole a cui si applica o per tutte le regole in questa categoria (gestibilità) a cui si applica. Per altre informazioni, vedere Opzioni di configurazione delle regole di qualità del codice.

Escludere simboli specifici

È possibile escludere simboli specifici, ad esempio tipi e metodi, dall'analisi. Ad esempio, per specificare che la regola non deve essere eseguita in alcun codice all'interno di tipi denominati MyType, aggiungere la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

Formati di nome simbolo consentiti nel valore dell'opzione (separati da |):

Solo nome simbolo (include tutti i simboli con il nome, indipendentemente dal tipo o dallo spazio dei nomi contenitore).
Nomi completi nel formato ID della documentazione del simbolo. Ogni nome di simbolo richiede un prefisso di tipo simbolo, ad esempio M: per i metodi, T: per i tipi e N: per gli spazi dei nomi.
.ctor per costruttori e .cctor per costruttori statici.

Esempi:

Valore opzione	Riepilogo
`dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType`	Corrisponde a tutti i simboli denominati `MyType`.
`dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType1\|MyType2`	Corrisponde a tutti i simboli denominati `MyType1` o `MyType2`.
`dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS.MyType.MyMethod(ParamType)`	Corrisponde a un metodo `MyMethod` specifico con la firma completa specificata.
`dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS1.MyType1.MyMethod1(ParamType)\|M:NS2.MyType2.MyMethod2(ParamType)`	Trova la corrispondenza con metodi `MyMethod1` specifici e `MyMethod2` con le rispettive firme complete.

Escludere tipi specifici e i relativi tipi derivati

È possibile escludere tipi specifici e i relativi tipi derivati dall'analisi. Ad esempio, per specificare che la regola non deve essere eseguita in alcun metodo all'interno di tipi denominati MyType e dei relativi tipi derivati, aggiungere la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType