Конвенція про іменування Енума - множина

Я задаю це запитання, незважаючи на те, що я прочитав подібне, але не зовсім те, що я хочу на C # імені конвенції для іменування та відповідності властивості

Я виявив, що я схильний називати переліки у множині, а потім 'використовувати' їх як однини, наприклад:

public enum EntityTypes {
  Type1, Type2
}

public class SomeClass {
  /*
    some codes
  */

  public EntityTypes EntityType {get; set;}

}

Звичайно, це працює, і це мій стиль, але чи може хтось знайти потенційну проблему з такою умовою? У мене є "потворне" найменування словом "Статус", хоча:

public enum OrderStatuses {
  Pending, Fulfilled, Error, Blah, Blah
}

public class SomeClass {
  /*
    some codes
  */

  public OrderStatuses OrderStatus {get; set;}

}

Додаткова інформація: Можливо, моє питання було недостатньо зрозумілим. Мені часто доводиться довго думати, називаючи змінні моїх визначених типів enum. Я знаю найкращу практику, але це не допомагає полегшити роботу щодо іменування цих змінних.

Я не можу викрити всі свої властивості перерахунків (скажімо "Статус") як "MyStatus".

Моє запитання: Чи може хтось знайти потенційну проблему в моїй конвенції, описаній вище? НЕ про найкращу практику.

Перефразовуйте питання:

Ну, я думаю, я повинен поставити запитання таким чином: Чи може хтось викласти хороший загальний спосіб іменування типу enum таким, що при використанні іменування enum 'екземпляр' буде досить простим?

Microsoft рекомендує використовувати однину для Enums, якщо не Enumпредставляє бітові поля (також використовуйте FlagsAttribute). Див. Розділ Перерахування типів переліку назв (підмножина Посібників з іменування Microsoft ).

Щоб відповісти на ваше роз'яснення, я не бачу нічого поганого ні в одному з наступних:

public enum OrderStatus { Pending, Fulfilled, Error };

public class SomeClass { 
    public OrderStatus OrderStatus { get; set; }
}

або

public enum OrderStatus { Pending, Fulfilled, Error };

public class SomeClass {
    public OrderStatus Status { get; set; }
}

Я почав називати переліки в множині, але з тих пір змінився на однину. Здається, це має більше сенсу в контексті того, де вони використовуються.

enum Status { Unknown = 0, Incomplete, Ready }

Status myStatus = Status.Ready;

Порівняти з:

Statuses myStatus = Statuses.Ready;

Я вважаю, що особливість форми звучить природніше в контексті. Ми погоджуємось, що, оголошуючи перелік, який відбувається в одному місці, ми думаємо, що «це група судівників», але при використанні її, імовірно, у багатьох місцях, ми думаємо, що «це одна річ» .

Ситуація ніколи насправді не стосується множини.

enumПоказує ознака чого - то або інше. Наведу приклад:

enum Humour
{
  Irony,
  Sarcasm,
  Slapstick,
  Nothing
}

Ви можете мати один тип, але спробуйте продумати його у множині, а не в множині:

Humour.Irony | Humour.Sarcasm

Швидше ніж

Humours { Irony, Sarcasm }

У вас є почуття гумору, у вас немає почуття гумору.

Загалом, рекомендація щодо найкращої практики є одниною, за винятком тих переліків, у яких прикріплений атрибут [Прапори] (і тому вони можуть містити бітові поля), які мають бути множинами.

Прочитавши ваше відредаговане запитання, я відчуваю, що ви можете подумати, що ім'я властивості чи ім’я змінної має відрізнятися від імені типу enum ... Це не так. Далі ідеально чудово ...

  public enum Status { New, Edited, Approved, Cancelled, Closed }

  public class Order
  {
      private Status stat;
      public Status Status
      { 
         get { return stat; }
         set { stat = value; }
      }
  }

Це одне з небагатьох місць, з якими я не згоден з конвенцією, достатньо, щоб піти проти неї. ТБХ, Я НЕ ХАЮ, що визначення перерахунку та його екземпляр можуть мати те саме ім’я. Я розміщую всі свої "Енуми" спеціально, тому що це дає зрозуміти, який це контекст у будь-якому використанні. IMO це робить код набагато читабельнішим.

public enum PersonTypesEnum {
    smart,
    sad,
    funny,
    angry
}


public class Person {   
    public PersonTypesEnum PersonType {get; set;}
}

Ніхто ніколи не буде плутати, що таке перерахунок і що є його примірником.

Якщо ви намагаєтесь писати прямо, але заборонений код на зразок цього:

    public class Person
    {
        public enum Gender
        {
            Male,
            Female
        }
        //Won't compile: auto-property has same name as enum
        public Gender Gender { get; set; }  
    }

Ваші варіанти:

1. Ігноруйте рекомендації MS та використовуйте префікс або суфікс для назви enum:

   public class Person
   {
       public enum GenderEnum
       {
           Male,
           Female
       }
       public GenderEnum Gender { get; set; }
   }

2. Перемістіть визначення enum поза класом, бажано, в інший клас. Ось просте рішення вищезазначеного:

   public class Characteristics
   {
       public enum Gender
       {
           Male,
           Female
       }
   }
   public class Person
   {
       public Characteristics.Gender Gender { get; set; }  
   }

Краща практика - використовувати однину. У вас є список предметів, які складають Enum. Використання елемента в списку звучить дивно, коли ви говорите Versions.1_0. Це має сенс сказати, Version.1_0оскільки існує лише одна версія 1_0.

Заходить трохи пізно ...

Існує важлива різниця між вашим запитанням і тим, яке ви згадуєте (яке я запитав ;-):

Ви ставите визначення enum з класу, що дозволяє вам мати однакове ім'я для enum та властивості:

public enum EntityType { 
  Type1, Type2 
} 

public class SomeClass { 
  public EntityType EntityType {get; set;} // This is legal

}

У цьому випадку я б дотримувався правил MS та використовував одне ім’я для enum (множина для прапорів). Це, швидше за все, найпростіше рішення.

Моя проблема (в іншому питанні ) полягає в тому, коли enum визначається в області класу, що перешкоджає використанню властивості, названої саме після enum.

З іншого потоку C # називає умовою для перерахування властивостей і суміщення хтось вказав, що, на мою думку, є дуже хорошою ідеєю:

"Я знаю, що моя пропозиція суперечить конвенціям .NET іменування, але я особисто префікс перераховує" E "і прапор переписує з" F "(подібно до того, як ми префіксуємо інтерфейси" I ")."