CA1712: Nezačínejte hodnoty výčtu s názvem typu
Vlastnost | Hodnota |
---|---|
ID pravidla | CA1712 |
Název | Nezačínejte hodnoty výčtu názvem typu |
Kategorie | Pojmenování |
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
Výčet obsahuje člena, jehož název začíná názvem typu výčtu.
Popis pravidla
Názvy členů výčtu nemají předponu názvu typu, protože se očekává, že informace o typu budou poskytovány vývojářskými nástroji.
Konvence vytváření názvů poskytují společný vzhled knihoven, které cílí na modul CLR (Common Language Runtime). To zkracuje dobu potřebnou k tomu, aby se naučila novou softwarovou knihovnu, a zvyšuje důvěru zákazníků, že knihovnu vyvinul někdo, kdo má zkušenosti s vývojem spravovaného kódu.
Jak opravit porušení
Chcete-li opravit porušení tohoto pravidla, odeberte předponu názvu typu ze člena výčtu.
Kdy potlačit upozornění
Nepotlačujte upozornění na toto pravidlo.
Příklad
Následující příklad ukazuje nesprávně pojmenovaný výčet následovaný opravenou verzí.
public enum DigitalImageMode
{
DigitalImageModeBitmap = 0,
DigitalImageModeGrayscale = 1,
DigitalImageModeIndexed = 2,
DigitalImageModeRGB = 3
}
public enum DigitalImageMode2
{
Bitmap = 0,
Grayscale = 1,
Indexed = 2,
RGB = 3
}
Imports System
Namespace ca1712
Enum DigitalImageMode
DigitalImageModeBitmap = 0
DigitalImageModeGrayscale = 1
DigitalImageModeIndexed = 2
DigitalImageModeRGB = 3
End Enum
Enum DigitalImageMode2
Bitmap = 0
Grayscale = 1
Indexed = 2
RGB = 3
End Enum
End Namespace
Související pravidla
- CA1711: Identifikátory by neměly mít nesprávnou příponu
- CA1027: Označte výčty pomocí FlagsAttribute
- CA2217: Neoznačujte výčty pomocí FlagsAttribute
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 (pojmenování), na která platí. Další informace naleznete v tématu Možnosti konfigurace pravidla kvality kódu.
Trigger předpony hodnot výčtu
Můžete nakonfigurovat počet hodnot výčtu požadovaných k aktivaci pravidla. Pokud chcete například určit, že se pravidlo aktivuje, pokud jedna nebo více hodnot výčtu začíná názvem typu výčtu, přidejte do souboru .editorconfig v projektu následující dvojici klíč-hodnota:
dotnet_code_quality.CA1712.enum_values_prefix_trigger = AnyEnumValue
Příklady:
Hodnota možnosti | Shrnutí |
---|---|
dotnet_code_quality.CA1712.enum_values_prefix_trigger = AnyEnumValue |
Pravidlo se aktivuje, pokud některý z hodnot výčtu začíná názvem typu výčtu. |
dotnet_code_quality.CA1712.enum_values_prefix_trigger = AllEnumValues |
Pravidlo se aktivuje, pokud všechny hodnoty výčtu začínají názvem typu výčtu. |
dotnet_code_quality.CA1712.enum_values_prefix_trigger = Heuristic |
Pravidlo se aktivuje pomocí výchozí heuristické, tj. když alespoň 75 % hodnot výčtu začíná názvem typu výčtu. |