CA1028: L'archivio di enum deve essere Int32

  • Articolo
Proprietà valore
ID regola CA1028
Titolo Le risorse di archiviazione dell'enumerazione devono essere Int32
Categoria Progettazione
Correzione che causa un'interruzione o un'interruzione Interruzione
Abilitato per impostazione predefinita in .NET 8 No

Causa

Il tipo sottostante di un'enumerazione non System.Int32è .

Per impostazione predefinita, questa regola esamina solo enumerazioni visibili esternamente, ma è configurabile.

Descrizione regola

Un'enumerazione è un tipo di valore che definisce un insieme di costanti denominate correlate. Per impostazione predefinita, il System.Int32 tipo di dati viene usato per archiviare il valore costante. Anche se è possibile modificare questo tipo sottostante, non è necessario o consigliato per la maggior parte degli scenari. Non si ottiene alcun miglioramento significativo delle prestazioni usando un tipo di dati minore di Int32. Se non è possibile usare il tipo di dati predefinito, è necessario utilizzare uno dei tipi Byteintegrali conformi a COMMON Language System (CLS), , Int16, Int32o Int64 per assicurarsi che tutti i valori dell'enumerazione possano essere rappresentati nei linguaggi di programmazione conformi a CLS.

Come correggere le violazioni

Per correggere una violazione di questa regola, a meno che non esistano problemi di compatibilità o dimensioni, usare Int32. Per le situazioni in cui Int32 non è sufficiente contenere i valori, usare Int64. Se la compatibilità con le versioni precedenti richiede un tipo di dati più piccolo, usare Byte o Int16.

Quando eliminare gli avvisi

Eliminare un avviso da questa regola solo se sono necessari problemi di compatibilità con le versioni precedenti. Nelle applicazioni, l'impossibilità di rispettare questa regola in genere non causa problemi. Nelle librerie, in cui è necessaria l'interoperabilità del linguaggio, la mancata conformità a questa regola potrebbe influire negativamente sugli utenti.

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 CA1028
// The code that's violating the rule is on this line.
#pragma warning restore CA1028

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.CA1028.severity = none

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

Configurare il codice da analizzare

Usare l'opzione seguente per configurare le parti della codebase in cui eseguire questa regola.

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

Includere superfici API specifiche

È possibile configurare le parti della codebase in modo da eseguire questa regola in base all'accessibilità. Ad esempio, per specificare che la regola deve essere eseguita solo sulla superficie dell'API non pubblica, aggiungere la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Esempio

L'esempio seguente mostra due enumerazioni che non usano il tipo di dati sottostante consigliato.

[Flags]
public enum Days : uint
{
    None = 0,
    Monday = 1,
    Tuesday = 2,
    Wednesday = 4,
    Thursday = 8,
    Friday = 16,
    All = Monday | Tuesday | Wednesday | Thursday | Friday
}

public enum Color : sbyte
{
    None = 0,
    Red = 1,
    Orange = 3,
    Yellow = 4
}

<Flags()>
Public Enum Days As UInteger
    None = 0
    Monday = 1
    Tuesday = 2
    Wednesday = 4
    Thursday = 8
    Friday = 16
    All = Monday Or Tuesday Or Wednesday Or Thursday Or Friday
End Enum

Public Enum Color As SByte
    None = 0
    Red = 1
    Orange = 3
    Yellow = 4
End Enum

Nell'esempio seguente viene risolta la violazione precedente modificando il tipo di dati sottostante in Int32.

[Flags]
public enum Days : int
{
    None = 0,
    Monday = 1,
    Tuesday = 2,
    Wednesday = 4,
    Thursday = 8,
    Friday = 16,
    All = Monday | Tuesday | Wednesday | Thursday | Friday
}

public enum Color : int
{
    None = 0,
    Red = 1,
    Orange = 3,
    Yellow = 4
}

<Flags()>
Public Enum Days As Integer
    None = 0
    Monday = 1
    Tuesday = 2
    Wednesday = 4
    Thursday = 8
    Friday = 16
    All = Monday Or Tuesday Or Wednesday Or Thursday Or Friday
End Enum

Public Enum Color As Integer
    None = 0
    Red = 1
    Orange = 3
    Yellow = 4
End Enum

Vedi anche