CA1714: Vlaggen enums moeten meervoudsnamen hebben

Eigenschap Waarde
Regel-id CA1714
Titel Opsommingen van vlaggen moeten meervoudsnamen hebben
Categorie Naamgeving
Fix kan brekend of niet-brekend zijn Onderbreking
Standaard ingeschakeld in .NET 10 Nee
Toepasselijke talen C# en Visual Basic

Oorzaak

Een opsomming heeft de System.FlagsAttribute en de naam eindigt niet op 's'.

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

Beschrijving van regel

Typen die zijn gemarkeerd met FlagsAttribute namen die meervoud hebben, omdat het kenmerk aangeeft dat er meer dan één waarde kan worden opgegeven. 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 zou de FlagsAttribute kunnen hebben en kan 'Dagen' worden genoemd. Een vergelijkbare opsomming waarmee slechts één dag kan worden opgegeven, heeft het kenmerk niet en kan 'Dag' worden genoemd.

Naamconventies zorgen voor een eenduidige uitstraling voor bibliotheken die gericht zijn op de Common Language Runtime (CLR). Dit vermindert de leercurve die vereist is voor nieuwe softwarebibliotheken en verhoogt het vertrouwen van klanten dat de bibliotheek is ontwikkeld door iemand die expertise heeft in het ontwikkelen van beheerde code.

Hoe schendingen op te lossen

Maak de naam van de opsomming een meervoudwoord of verwijder het FlagsAttribute kenmerk als er niet tegelijkertijd meerdere opsommingswaarden mogen worden opgegeven.

Wanneer waarschuwingen onderdrukken

Het is veilig om een schending te onderdrukken als de naam een meervoud woord is, maar niet eindigt op 's'. Als de opsomming van meerdere dagen die eerder is beschreven bijvoorbeeld 'DaysOfTheWeek' werd genoemd, zou dit de logica van de regel schenden, maar niet de bedoeling ervan. Dergelijke schendingen moeten worden onderdrukt.

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 CA1714
// The code that's violating the rule is on this line.
#pragma warning restore CA1714

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.CA1714.severity = none

Zie voor meer informatie Hoe codeanalysewaarschuwingen te onderdrukken.

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 configureren op welke onderdelen van uw codebase deze regel moet worden uitgevoerd, op basis van hun toegankelijkheid, door de optie api_surface in te stellen. 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

Notitie

Vervang het XXXX deel van CAXXXX door de id van de toepasselijke regel.

Zie ook

  • Last updated on