Teilen über

CA1028: Der Enumerationsspeicher sollte Int32 sein.

  • Artikel
Eigenschaft Wert
Regel-ID CA1028
Titel Der Enumerationsspeicher sollte Int32 sein.
Kategorie Design
Fix führt oder führt nicht zur Unterbrechung Breaking
Standardmäßig in .NET 8 aktiviert Nein

Ursache

Der einer Enumeration zugrunde liegende Typ ist nicht System.Int32.

Standardmäßig werden mit dieser Regel nur extern sichtbare Enumerationen überprüft, aber dies ist konfigurierbar.

Regelbeschreibung

Eine Enumeration ist ein Werttyp, der einen Satz verwandter benannter Konstanten definiert. Standardmäßig wird zum Speichern des konstanten Werts der System.Int32-Datentyp verwendet. Sie können diesen zugrunde liegenden Typ zwar ändern, aber in den meisten Szenarien ist dies weder notwendig noch empfehlenswert. Durch die Verwendung eines Datentyps, der kleiner als Int32 ist, wird kein erheblicher Leistungsgewinn erzielt. Wenn Sie den Standard-Datentyp nicht verwenden können, sollten Sie einen der CLS-kompatiblen ganzzahligen Typen (CLS - Common Language System) Byte, Int16, Int32 oder Int64 verwenden, um sicherzustellen, dass alle Werte der Enumeration in CLS-kompatiblen Programmiersprachen dargestellt werden können.

Behandeln von Verstößen

Um einen Verstoß gegen diese Regel zu beheben, sofern keine Größen-oder Kompatibilitätsprobleme vorhanden sind, verwenden Sie Int32. Verwenden Sie für Situationen, in denen Int32 nicht groß genug ist, um die Werte zu speichern, verwenden Sie Int64. Wenn die Abwärtskompatibilität einen kleineren Datentyp erfordert, verwenden Sie Byte oder Int16.

Wann sollten Warnungen unterdrückt werden?

Unterdrücken Sie eine Warnung aus dieser Regel nur, wenn dies bei Problemen mit der Abwärtskompatibilität erforderlich ist. In Anwendungen verursacht die Nichteinhaltung dieser Regel üblicherweise keine Probleme. In Bibliotheken, bei denen die SprachiInteroperabilität erforderlich ist, kann sich die Einhaltung dieser Regel nicht negativ auf die Benutzer auswirken.

Unterdrücken einer Warnung

Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.

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

Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none fest.

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

Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.

Konfigurieren des zu analysierenden Codes

Mithilfe der folgenden Option können Sie konfigurieren, für welche Teile Ihrer Codebasis diese Regel ausgeführt werden soll.

Sie können diese Optionen nur für diese Regel, für alle zutreffenden Regeln oder für alle zutreffenden Regeln in dieser Kategorie (Entwurf) konfigurieren. Weitere Informationen finden Sie unter Konfigurationsoptionen für die Codequalitätsregel.

Einschließen bestimmter API-Oberflächen

Sie können je nach Zugänglichkeit festlegen, für welche Bestandteile Ihrer Codebasis diese Regel ausgeführt wird. Sie können beispielsweise festlegen, dass die Regel nur für die nicht öffentliche API-Oberfläche ausgeführt werden soll, indem Sie einer EDITORCONFIG-Datei in Ihrem Projekt das folgende Schlüssel-Wert-Paar hinzufügen:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Beispiel

Das folgende Beispiel zeigt zwei Enumerationen, die den empfohlenen zugrunde liegenden Datentyp nicht verwenden.

[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

Im folgenden Beispiel wird der vorherige Verstoß korrigiert, indem der zugrunde liegende Datentyp in Int32 geändert wird.

[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

Siehe auch