CA1712: A típusnévvel rendelkező enumerálási értékek előtagja nem
Tulajdonság | Érték |
---|---|
Szabályazonosító | CA1712 |
Cím | Ne adja meg a típusnévvel rendelkező enumerálási értékeket |
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 enumerálás olyan tagot tartalmaz, akinek a neve az enumerálás típusnevével kezdődik.
Szabály leírása
Az enumerálási tagok neve nem előtaggal van ellátva a típusnévvel, mert a típusinformációkat várhatóan a fejlesztői eszközök adják meg.
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 szoftvertárak megismeréséhez szükséges idő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ódok fejlesztésében.
Szabálysértések kijavítása
A szabály megsértésének kijavításához távolítsa el a típusnév előtagját az enumerálási tagból.
Mikor kell letiltani a figyelmeztetéseket?
Ne tiltsa el a szabály figyelmeztetését.
Példa
Az alábbi példában egy helytelenül elnevezett enumerálás látható, amelyet a javított verzió követ.
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
Kapcsolódó szabályok
- CA1711: Az azonosítóknak nem szabad helytelen utótagot adni
- CA1027: Számjelek megjelölése FlagsAttribute használatával
- CA2217: Ne jelölje meg a számokat a FlagsAttribute használatával
Kód konfigurálása elemzéshez
A következő beállítással konfigurálhatja, hogy a kódbázis mely részein futtassa ezt a szabályt.
Ezt a beállítást 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.
Enumerálási értékek előtag-eseményindítója
Konfigurálhatja a szabály aktiválásához szükséges enumerálási értékek számát. Ha például meg szeretné adni, hogy a szabály aktiválódjon, ha egy vagy több enumerálási érték a számtípus nevével kezdődik, adja hozzá a következő kulcs-érték párot a projekt egyik .editorconfig fájljához:
dotnet_code_quality.CA1712.enum_values_prefix_trigger = AnyEnumValue
Examples:
Beállítás értéke | Összesítés |
---|---|
dotnet_code_quality.CA1712.enum_values_prefix_trigger = AnyEnumValue |
A szabály akkor aktiválódik, ha a számértékek bármelyike a számtípus nevével kezdődik. |
dotnet_code_quality.CA1712.enum_values_prefix_trigger = AllEnumValues |
A szabály akkor aktiválódik, ha az összes enumerálási érték a számtípus nevével kezdődik. |
dotnet_code_quality.CA1712.enum_values_prefix_trigger = Heuristic |
A szabály az alapértelmezett heurisztikus módszerrel aktiválódik, vagyis amikor a számértékek legalább 75%-a a számtípus nevével kezdődik. |