Delen via

CA1711: Id's mogen geen onjuist achtervoegsel hebben

  • Artikel
Eigenschappen Weergegeven als
Regel-id CA1711
Titel Id's mogen geen onjuist achtervoegsel hebben
Categorie Naamgeving
Oplossing is brekend of niet-brekend Breken
Standaard ingeschakeld in .NET 9 Nee

Oorzaak

Een id heeft een onjuist achtervoegsel.

Deze regel kijkt standaard alleen naar extern zichtbare id's, maar dit kan worden geconfigureerd.

Beschrijving van regel

Volgens de conventie moeten alleen de namen van typen die bepaalde basistypen uitbreiden of bepaalde interfaces implementeren, of typen die zijn afgeleid van deze typen, eindigen met specifieke gereserveerde achtervoegsels. Andere typenamen mogen deze gereserveerde achtervoegsels niet gebruiken.

De volgende tabel bevat de gereserveerde achtervoegsels en de basistypen en interfaces waaraan ze zijn gekoppeld.

Achtervoegsel Basistype/interface
Kenmerk System.Attribute
Verzameling System.Collections.ICollection

System.Collections.IEnumerable

System.Collections.Queue

System.Collections.Stack

System.Collections.Generic.ICollection<T>

System.Data.DataSet

System.Data.DataTable
Woordenlijst System.Collections.IDictionary

System.Collections.Generic.IDictionary<TKey,TValue>
EventArgs System.EventArgs
EventHandler Een gedelegeerde voor een gebeurtenis-handler
Uitzondering System.Exception
Machtiging System.Security.IPermission
Queue System.Collections.Queue
Stack System.Collections.Stack
Stream System.IO.Stream

Bovendien mogen de volgende achtervoegsels niet worden gebruikt:

  • Delegate
  • Enum
  • Impl (gebruik Core in plaats daarvan)
  • Ex of vergelijkbaar achtervoegsel om het te onderscheiden van een eerdere versie van hetzelfde type
  • Flag of Flags voor opsommingstypen

Naamconventies bieden een gemeenschappelijk uiterlijk voor bibliotheken die gericht zijn op de algemene taalruntime. 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. Zie Naamgevingsrichtlijnen: Klassen, Structs en Interfaces voor meer informatie.

Schendingen oplossen

Verwijder het achtervoegsel uit de typenaam.

Wanneer waarschuwingen onderdrukken

Onderdrukt geen waarschuwing van deze regel, tenzij het achtervoegsel een ondubbelzinnige betekenis heeft in het toepassingsdomein.

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

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

Zie Codeanalysewaarschuwingen onderdrukken voor meer informatie.

Code configureren om te analyseren

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

U kunt deze opties 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

Achtervoegsels toestaan

U kunt een lijst met toegestane achtervoegsels configureren, waarbij elk achtervoegsel wordt gescheiden door het pipeteken (|). Als u bijvoorbeeld wilt opgeven dat de regel niet mag worden uitgevoerd op vlag- en vlaggenachtervoegsels, voegt u het volgende sleutel-waardepaar toe aan een .editorconfig-bestand in uw project:

dotnet_code_quality.ca1711.allowed_suffixes = Flag|Flags

Zie ook