Sdílet prostřednictvím


CA1712: Nezačínejte hodnoty výčtu s názvem typu

Název_typu

DoNotPrefixEnumValuesWithTypeName

CheckId

CA1712

Kategorie

Microsoft.Naming

Změnit rozdělení

Rozdělení

Příčina

Výčet obsahuje člen, jejichž název začíná název typ výčtu.

Popis pravidla

Názvy členů výčtu není předponou s názvem typ, protože očekává typ informací, poskytuje nástroje pro vývoj.

Konvence stanovit společné vzhled knihovny tomuto cíli společného jazykového modulu runtime.To snižuje čas, který je vyžadován pro informace o nové knihovny softwaru a zvyšuje důvěru zákazníků, že osoba, která má odborné znalosti v rozvojových spravovaný kód byl vyvinut knihovny.

Jak opravit porušení

Opravit porušení tohoto pravidla, odeberte předponu názvu typu člena výčtu.

Při potlačení upozornění

Nepotlačovat upozornění od tohoto pravidla.

Příklad

Následující příklad zobrazuje nesprávně pojmenované výčet následuje opravenou verzí.

Imports System

Namespace NamingLibrary

   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
using System;

namespace NamingLibrary
{
   public enum DigitalImageMode
   {
      DigitalImageModeBitmap = 0,
      DigitalImageModeGrayscale = 1,
      DigitalImageModeIndexed = 2,
      DigitalImageModeRGB = 3
   }

   public enum DigitalImageMode2
   {
      Bitmap = 0,
      Grayscale = 1,
      Indexed = 2,
      RGB = 3
   }
}
using namespace System;

namespace NamingLibrary
{
   public enum class DigitalImageMode
   {
      DigitalImageModeBitmap = 0,
      DigitalImageModeGrayscale = 1,
      DigitalImageModeIndexed = 2,
      DigitalImageModeRGB = 3
   };

   public enum class DigitalImageMode2
   {
      Bitmap = 0,
      Grayscale = 1,
      Indexed = 2,
      RGB = 3
   };
}

Souvisejících pravidel

CA1711: Identifikátory by neměly mít nesprávnou příponu

CA1027: Označte výčty pomocí FlagsAttribute

CA2217: Neoznačujte výčty pomocí FlagsAttribute

Viz také

Referenční dokumentace

Enum