CA1711: Az azonosítóknak nem szabad helytelen utótagot adni
Tulajdonság | Érték |
---|---|
Szabályazonosító | CA1711 |
Cím | Az azonosítóknak nem szabad helytelen utótagokkal rendelkezniük |
Kategória | Elnevezés |
A javítás kompatibilitástörő vagy nem törik | Törés |
Alapértelmezés szerint engedélyezve a .NET 8-ban | Nem |
Ok
Az azonosítók utótagja helytelen.
Ez a szabály alapértelmezés szerint csak külsőleg látható azonosítókat tekint meg, de ez konfigurálható.
Szabály leírása
Konvenció szerint csak azoknak a típusoknak a neve, amelyek bizonyos alaptípusokat bővítenek ki, vagy amelyek bizonyos interfészeket implementálnak, vagy az ezekből a típusokból származtatott típusok, meghatározott fenntartott utótagokkal végződnek. Más típusnevek nem használhatják ezeket a fenntartott utótagokat.
Az alábbi táblázat felsorolja a fenntartott utótagokat, valamint azokat az alaptípusokat és interfészeket, amelyekhez társítva vannak.
Utótag | Alaptípus/interfész |
---|---|
Attribútum | System.Attribute |
Gyűjtemény | System.Collections.ICollection System.Collections.IEnumerable System.Collections.Queue System.Collections.Stack System.Collections.Generic.ICollection<T> System.Data.DataSet System.Data.DataTable |
Szótár | System.Collections.IDictionary System.Collections.Generic.IDictionary<TKey,TValue> |
EventArgs | System.EventArgs |
EventHandler | Eseménykezelő delegált |
Exception | System.Exception |
Permission | System.Security.IPermission |
Várakozási sor | System.Collections.Queue |
Verem | System.Collections.Stack |
Stream | System.IO.Stream |
Ezenkívül a következő utótagokat nem szabad használni:
Delegate
Enum
Impl
(használjaCore
inkább)Ex
vagy hasonló utótagot az azonos típusú korábbi verzióktól való megkülönböztetéséhezFlag
vagyFlags
enumerálási típusok esetén
Az elnevezési konvenciók gyakran keresik a közös nyelvi futtatókörnyezetet megcélzó kódtárakat. Ez csökkenti az új szoftverkódtárakhoz szükséges tanulási görbét, és növeli az ügyfelek bizalmát abban, hogy a kódtárat olyan személy fejlesztette ki, aki jártas a felügyelt kód fejlesztésében. További információ: Elnevezési irányelvek: Osztályok, szerkezetek és felületek.
Szabálysértések kijavítása
Távolítsa el az utótagot a típusnévből.
Mikor kell letiltani a figyelmeztetéseket?
Ne tiltsa el a szabály figyelmeztetését, kivéve, ha az utótagnak egyértelmű jelentése van az alkalmazástartományban.
Figyelmeztetés mellőzése
Ha csak egyetlen szabálysértést szeretne letiltani, adjon hozzá előfeldolgozási irányelveket a forrásfájlhoz a szabály letiltásához és újbóli engedélyezéséhez.
#pragma warning disable CA1711
// The code that's violating the rule is on this line.
#pragma warning restore CA1711
Ha le szeretné tiltani egy fájl, mappa vagy projekt szabályát, állítsa annak súlyosságát none
a konfigurációs fájlban.
[*.{cs,vb}]
dotnet_diagnostic.CA1711.severity = none
További információ: Kódelemzési figyelmeztetések letiltása.
Kód konfigurálása elemzéshez
A következő beállítások segítségével konfigurálhatja, hogy a kódbázis mely részein futtassa ezt a szabályt.
Ezeket a beállításokat konfigurálhatja csak erre a szabályra, az összes szabályra, vagy az ebben a kategóriában (elnevezés) szereplő összes szabályra, amelyekre vonatkozik. További információ: Kódminőségi szabály konfigurációs beállításai.
Adott API-felületek belefoglalása
A kódbázis azon részeit konfigurálhatja, amelyeken futtathatja ezt a szabályt az akadálymentességük alapján. Ha például meg szeretné adni, hogy a szabály csak a nem nyilvános API-felületen fusson, adja hozzá a következő kulcs-érték párot a projekt egyik .editorconfig fájljához:
dotnet_code_quality.CAXXXX.api_surface = private, internal
Utótagok engedélyezése
Konfigurálhatja az engedélyezett utótagok listáját, az egyes utótagokat pedig a pipa karakter ("|") választja el egymástól. Ha például meg szeretné adni, hogy a szabály ne fusson a Jelző és a Jelzők utótagok között, adja hozzá a következő kulcs-érték párot a projekt egyik .editorconfig fájljához:
dotnet_code_quality.ca1711.allowed_suffixes = Flag|Flags
Kapcsolódó szabályok
Kapcsolódó információk
Visszajelzés
https://aka.ms/ContentUserFeedback.
Hamarosan elérhető: 2024-ben fokozatosan kivezetjük a GitHub-problémákat a tartalom visszajelzési mechanizmusaként, és lecseréljük egy új visszajelzési rendszerre. További információ:Visszajelzés küldése és megtekintése a következőhöz: