Конвенція іменування C # для переліку та відповідності властивості

Я часто виявляю себе реалізовуючим клас, що підтримує якусь власну властивість статусу як перерахування: у мене є перелік статусу та ОДНА властивість статусу типу Status. Як мені вирішити цей конфлікт назв?

public class Car
{
  public enum Status
  {
    Off,
    Starting,
    Moving
  };

  Status status = Status.Off;

  public Status Status // <===== Won't compile =====
  {
    get { return status; }
    set { status = value; DoSomething(); }
  }
}

Якби перелік Status був загальним для різних типів, я б поставив його поза класом, і проблема була б вирішена. Але Статус застосовується лише до автомобіля, тому не має сенсу оголошувати перелік поза класом.

Яку конвенцію іменування ви використовуєте в цьому випадку?

NB: Це питання частково обговорювалось у коментарях до відповіді на це питання . Оскільки це не було головним питанням, воно не мало великої видимості.

РЕДАГУВАТИ: Філіп Екберг пропонує відмінне рішення ІМО для конкретного випадку "Статусу". Тим НЕ менше , я б цікаво читати про рішення , де ім'я перерахувань / власність відрізняється, як і в Майкла Prewecki в відповідь .

EDIT2 (травень 2010 р.): Моє улюблене рішення - це плюралізація імені типу перечислення, як запропонував Кріс С. Відповідно до керівних принципів MS, це слід використовувати лише для перелічень прапорів. Але мені це все більше подобається. Зараз я використовую його і для регулярних зарахувань.

Я додаю до обговорення свій 1 євро, але це, мабуть, не додає нічого нового.

Очевидним рішенням є переміщення Status із вкладеного Enum. Більшість перечислень .NET (за винятком, можливо, деяких у просторі імен Windows.Forms) не вкладені, і це дратує використання для розробника, який споживає ваш API, з необхідністю вводити префікс до імені класу.

Одне, про що не згадувалось, - це те, що перелічення прапорів відповідно до керівних принципів MSDN мають бути іменниками з множиною, які ви, напевно, вже знаєте (Status - це просте перерахування, тому слід використовувати іменники однини).

State (enum, що називається States) - це вокатив, "Status" - номінатив іменника, який англійська мова, як і більшість нашої мови, вбирає з латини. Вокатив - це те, що ви називаєте іменником за його станом, а номінатив - предмет дієслова.

Отже, іншими словами, коли автомобіль рухається , це дієслово - рух - це його статус. Але машина не згасає, а її двигун. Він також не запускається, а двигун (ви, мабуть, вибрали тут приклад, тому це може бути неактуальним).

public class Car
{
  VehicleState _vehicleState= VehicleState.Stationary;

  public VehicleState VehicleState 
  {
    get { return _vehicleState; }
    set { _vehicleState = value; DoSomething(); }
  }
}

public enum VehicleState
{
    Stationary, Idle, Moving
}

Держава - це такий узагальнений іменник, чи не краще було б описати, до якого стану він має на увазі? Як я робив вище

Приклад типу також, на мій погляд, стосується не типу читача, а його бази даних. Я б віддав перевагу, якби ви описували продукт бази даних читача, який не обов'язково відповідає типу зчитувача (наприклад, тип зчитувача може бути лише пересиланням, кешованим тощо). Так

reader.Database = Databases.Oracle;

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

Визначення "вимкнено", "починається" та "рухається" - це те, що я б назвав "державою". І коли ви натякаєте, що використовуєте "штат", це ваш "статус". Так!

public class Car
{
  public enum State
  {
    Off,
    Starting,
    Moving
  };

  State state = State.Off;

  public State Status
  {
    get { return state ; }
    set { state= value; DoSomething(); }
  }
}

Якщо ми візьмемо інший приклад із зазначеного, де ви хочете використовувати слово "Тип", наприклад, у цьому випадку:

public class DataReader
{
    public enum Type
    {
        Sql,
        Oracle,
        OleDb
    }

    public Type Type { get; set; } // <===== Won't compile =====

}

Вам справді потрібно побачити, що між переліченнями та переліками існує різниця, так? Але коли створюєте фреймворк або розмовляєте про архітектуру, вам потрібно зосередитись на подібності, добре давайте їх знайти:

Коли щось встановлено як стан, це визначається як статус "речей"

Приклад: Статус автомобіля знаходиться в робочому стані, зупиненому стані тощо.

Що ви хочете отримати в другому прикладі, дещо таке:

myDataReader.Type = DataReader.Database.OleDb

Ви можете подумати, що це суперечить тому, про що я проповідував іншим, що вам потрібно дотримуватися стандартів. Але, ви дотримуєтесь стандарту! Справа Sql є також конкретним випадком, тому потребує дещо конкретного рішення.

Однак перелік може бути повторно використаний у вашому System.Dataпросторі, і саме в цьому полягають шаблони.

Інший випадок, який слід поглянути на "Тип" - це "Тварина", де Тип визначає Види.

public class Animal
    {
        public enum Type
        {
            Mammal,
            Reptile,
            JonSkeet
        }

        public Type Species{ get; set; }

    }

Це слідує шаблону, вам не потрібно конкретно "знати" Об'єкт для цього, і ви не вказуєте "AnimalType" або "DataReaderType", ви можете повторно використовувати перелічення у вибраному просторі імен.

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

А ще краще, поставте свій перелік поза класом:

public enum Status
{
    Off,
    Starting,
    Moving
}

public class Car
{
    public Status Status
    { ... }
}

ОНОВЛЕННЯ

Через коментарі нижче я пояснитиму свій дизайн вище.

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

public class Car
{
    public enum Status
    {...}
    ...
    public Status CarStatus { get; set;}
}

У той час як деякі коментатори стверджують , що статус не мають ніякого значення поза рамками класу Car, той факт , що ви встановлюєте суспільне властивість означає , що Є інші частини програми , які будуть використовувати це перерахування:

public Car myCar = new Car();
myCar.CarStatus = Car.Status.Off;

І це для мене кодовий запах. Якщо я буду дивитися на цей статус зовнішньої частини Car, я міг би також визначити його межами , а також.

Таким чином, я, мабуть, просто перейменую його як:

public enum CarStatus
{...}

public class Car
{
    ...
    public CarStatus Status { get; set; }
}

Однак, якщо цей перелік буде використовуватися всередині класу автомобілів і тільки в ньому, тоді я добре оголошую там перелік.

Я знаю, що моя пропозиція суперечить конвенціям .NET Naming, але я особисто додаю префікси enum до "E", а прапорці enum до "F" (подібно до того, як ми додаємо інтерфейси до "I"). Я справді не розумію, чому це не конвенція. Enums / Flags - це особливий випадок, такий як Інтерфейси, які ніколи не змінять свій тип. Це не тільки дає зрозуміти, що це таке, це дуже легко ввести в intellisense, оскільки префікс фільтрує більшість інших типів / змінних / тощо, і у вас не буде цих зіткнень імен.

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

Ненависники угорської нотації та її варіантів будуть прокляті. Я використовую домовленість суфіксації перечислень з - чекай на це - Enum. Отже, у мене ніколи не виникає проблеми, яку ви описуєте, витрачаючи час на роздуми про те, як їх назвати, а код для читання та самоопису для завантаження.

public class Car
{
  public enum StatusEnum
  {
    Off,
    Starting,
    Moving
  };

  public StatusEnum Status { get; set; }

}

Я б змінив назву властивості на щось на зразок "CurrentStatus". Швидко і просто :)

Я пропоную додати назву "Option" до імені типу (або Flag, якщо воно містить бітові прапори), тобто тип - Car.StatusOption, а властивість - Car.Status.

Порівняно з плюралізацією, це дозволяє уникнути зіткнень імен при створенні колекцій типу enum, де зазвичай потрібно плюралізувати властивість колекції , а не тип enum .

Зазвичай я додаю префікси до переліків, наприклад CarStatus. Думаю, все залежить від команди, з якою ви працюєте (якщо у них є якісь правила / процеси для подібного роду) та використання об’єктів. Лише мої 2 центи (: