Sdílet prostřednictvím

CA1028: Úložiště výčtu by měl být Int32

  • Článek
Vlastnost Hodnota
ID pravidla CA1028
Název Úložiště výčtu by mělo být Int32
Kategorie Návrh
Oprava způsobující chybu nebo chybu způsobující chybu Narušující
Povoleno ve výchozím nastavení v .NET 9 No

Příčina

Základní typ výčtu není System.Int32.

Ve výchozím nastavení toto pravidlo sleduje jenom externě viditelné výčty, ale dá se konfigurovat.

Popis pravidla

Výčet je typ hodnoty, který definuje množinu souvisejících pojmenovaných konstant. Ve výchozím nastavení System.Int32 se datový typ používá k uložení konstantní hodnoty. I když tento základní typ můžete změnit, není nutné ani nedoporučujeme pro většinu scénářů. Nelze dosáhnout významného zvýšení výkonu pomocí datového typu, který je menší než Int32. Pokud nemůžete použít výchozí datový typ, měli byste použít jeden z integrálních typů Bytekompatibilních se standardem CLS (Common Language System), , Int16, Int32nebo Int64 zajistit, aby všechny hodnoty výčtu mohly být reprezentovány v programovacích jazycích kompatibilních se specifikací CLS.

Jak opravit porušení

Chcete-li opravit porušení tohoto pravidla, pokud neexistují problémy s velikostí nebo kompatibilitou, použijte Int32. V situacích, kdy Int32 není dostatečně velký k uložení hodnot, použijte Int64. Pokud zpětnou kompatibilitu vyžaduje menší datový typ, použijte Byte nebo Int16.

Kdy potlačit upozornění

Potlačit upozornění z tohoto pravidla pouze v případě, že ho vyžadují problémy se zpětnou kompatibilitou. Vaplikacích V knihovnách, kde je vyžadována interoperabilita jazyka, může selhání dodržování tohoto pravidla nepříznivě ovlivnit vaše uživatele.

Potlačení upozornění

Pokud chcete pouze potlačit jedno porušení, přidejte do zdrojového souboru direktivy preprocesoru, abyste pravidlo zakázali a znovu povolili.

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

Pokud chcete pravidlo pro soubor, složku nebo projekt zakázat, nastavte jeho závažnost v none konfiguračním souboru.

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

Další informace naleznete v tématu Jak potlačit upozornění analýzy kódu.

Konfigurace kódu pro analýzu

Pomocí následující možnosti nakonfigurujte, ve kterých částech základu kódu se má toto pravidlo spouštět.

Tuto možnost můžete nakonfigurovat jenom pro toto pravidlo, pro všechna pravidla, která platí, nebo pro všechna pravidla v této kategorii (Návrh), na která platí. Další informace naleznete v tématu Možnosti konfigurace pravidla kvality kódu.

Zahrnutí konkrétních povrchů rozhraní API

Nastavením možnosti api_surface můžete nakonfigurovat, na kterých částech základu kódu se má toto pravidlo spouštět na základě jejich přístupnosti. Pokud chcete například určit, že pravidlo by se mělo spouštět jenom na neveřejné ploše rozhraní API, přidejte do souboru .editorconfig v projektu následující pár klíč-hodnota:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Poznámka

Nahraďte XXXX část CAXXXX ID příslušného pravidla.

Příklad

Následující příklad ukazuje dva výčty, které nepoužívají doporučený podkladový datový typ.

[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

Následující příklad řeší předchozí porušení změnou základního datového typu na 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

Viz také