CA1712: Geef geen enumwaarden een voorvoegsel dat de typenaam bevat

Oorzaak

Een opsomming bevat een lid waarvan de naam begint met de typenaam van de opsomming.

Beschrijving van regel

Namen van opsommingsleden worden niet voorafgegaan door de naam van het type, omdat typegegevens naar verwachting worden verstrekt door ontwikkelhulpprogramma's.

Naamconventies zorgen voor een eenduidige uitstraling voor bibliotheken die gericht zijn op de Common Language Runtime (CLR). Dit verkort de tijd die nodig is voor het leren van een nieuwe softwarebibliotheek en verhoogt het vertrouwen van de klant dat de bibliotheek is ontwikkeld door iemand die ervaring heeft met het ontwikkelen van beheerde code.

Hoe schendingen op te lossen

Als u een schending van deze regel wilt oplossen, verwijdert u het voorvoegsel van het typenaam uit het opsommingslid.

Wanneer waarschuwingen onderdrukken

Een waarschuwing van deze regel niet onderdrukken.

Voorbeeld

In het volgende voorbeeld ziet u een onjuist benoemde opsomming, gevolgd door de gecorrigeerde versie.

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

Gerelateerde regels

• CA1711: Id's mogen geen onjuist achtervoegsel hebben
• CA1027: Opsommingen markeren met FlagsAttribute
• CA2217: Opsommingen niet markeren met FlagsAttribute

Code configureren om te analyseren

Gebruik de volgende optie om te configureren op welke onderdelen van uw codebase deze regel moet worden uitgevoerd.

• Enum-waarden voorvoegseltrigger

U kunt deze optie configureren voor alleen deze regel, voor alle regels waarop deze van toepassing is, of voor alle regels in deze categorie (naamgeving) waarop deze van toepassing is. Zie de configuratieopties voor de codekwaliteitsregel voor meer informatie.

Trigger voor voorvoegsel van enum-waarden

U kunt het aantal opsommingswaarden configureren dat is vereist om de regel te activeren. Als u bijvoorbeeld wilt opgeven dat de regel wordt geactiveerd als een of meer enum-waarden beginnen met de naam van het enum-type, voegt u het volgende sleutel-waardepaar toe aan een .editorconfig-bestand in uw project:

dotnet_code_quality.CA1712.enum_values_prefix_trigger = AnyEnumValue

Voorbeelden:

Zie ook

• System.Enum