Share via

CA1717: Alleen FlagsAttribute-opsommingen moeten meervoudsnamen hebben

  • Artikel
Eigenschappen Weergegeven als
Regel-id CA1717
Titel Alleen FlagsAttribute-opsommingen moeten meervoudsnamen hebben
Categorie Naamgeving
Oplossing is brekend of niet-brekend Breken
Standaard ingeschakeld in .NET 8 Nee

Oorzaak

De naam van een opsomming eindigt in een meervoudwoord en de opsomming wordt niet gemarkeerd met het System.FlagsAttribute kenmerk.

Deze regel kijkt standaard alleen naar extern zichtbare opsommingen, maar dit is configureerbaar.

Beschrijving van regel

Naamconventies bepalen dat een meervoudsnaam voor een opsomming aangeeft dat meer dan één waarde van de opsomming tegelijkertijd kan worden opgegeven. De FlagsAttribute compilers geven aan dat de opsomming moet worden behandeld als een bitveld waarmee bitsgewijze bewerkingen op de opsomming mogelijk worden.

Als slechts één waarde van een opsomming tegelijk kan worden opgegeven, moet de naam van de opsomming een enkel woord zijn. Een opsomming die bijvoorbeeld de dagen van de week definieert, is mogelijk bedoeld voor gebruik in een toepassing waarin u meerdere dagen kunt opgeven. Deze opsomming moet de FlagsAttribute naam 'Dagen' hebben. Een vergelijkbare opsomming waarmee slechts één dag kan worden opgegeven, heeft het kenmerk niet en kan 'Dag' worden genoemd.

Naamconventies bieden een gemeenschappelijk uiterlijk voor bibliotheken die gericht zijn op de algemene taalruntime. Dit verkort de tijd die nodig is om een nieuwe softwarebibliotheek te leren en verhoogt het vertrouwen van de klant dat de bibliotheek is ontwikkeld door iemand die expertise heeft bij het ontwikkelen van beheerde code.

Schendingen oplossen

Maak de naam van de opsomming een enkel woord of voeg het FlagsAttributetoe.

Wanneer waarschuwingen onderdrukken

Het is veilig om een waarschuwing van de regel te onderdrukken als de naam eindigt in een enkel woord.

Een waarschuwing onderdrukken

Als u slechts één schending wilt onderdrukken, voegt u preprocessorrichtlijnen toe aan uw bronbestand om de regel uit te schakelen en vervolgens opnieuw in te schakelen.

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

Als u de regel voor een bestand, map of project wilt uitschakelen, stelt u de ernst none ervan in op het configuratiebestand.

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

Zie Codeanalysewaarschuwingen onderdrukken voor meer informatie.

Code configureren om te analyseren

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

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.

Specifieke API-oppervlakken opnemen

U kunt instellen op welke onderdelen van uw codebase deze regel moet worden uitgevoerd, op basis van hun toegankelijkheid. Als u bijvoorbeeld wilt opgeven dat de regel alleen moet worden uitgevoerd op het niet-openbare API-oppervlak, voegt u het volgende sleutel-waardepaar toe aan een .editorconfig-bestand in uw project:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Zie ook