Enum Naming Convention - Plural

Sto facendo questa domanda nonostante abbia letto simili ma non esattamente quello che voglio alla convenzione di denominazione C # per enum e corrispondenti proprietà

Ho scoperto che ho la tendenza a nominare gli enum al plurale e poi a "usarli" come esempio singolare:

public enum EntityTypes {
  Type1, Type2
}

public class SomeClass {
  /*
    some codes
  */

  public EntityTypes EntityType {get; set;}

}

Ovviamente funziona e questo è il mio stile, ma qualcuno può trovare un potenziale problema con tale convenzione? Ho una denominazione "brutta" con la parola "Stato" però:

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

public class SomeClass {
  /*
    some codes
  */

  public OrderStatuses OrderStatus {get; set;}

}

Informazioni aggiuntive: forse la mia domanda non era abbastanza chiara. Spesso devo pensare intensamente quando nomina le variabili dei miei tipi di enum definiti. Conosco le migliori pratiche, ma non aiuta a facilitare il mio lavoro nel nominare quelle variabili.

Non posso esporre tutte le mie proprietà enum (dire "Status") come "MyStatus".

La mia domanda: qualcuno può trovare un potenziale problema con la mia convenzione sopra descritta? NON si tratta di buone pratiche.

Riforma della domanda:

Bene, suppongo che dovrei porre la domanda in questo modo: qualcuno può escogitare un buon modo generico di nominare il tipo di enum in modo tale che, se usato, la denominazione dell'istanza di enum sarà piuttosto semplice?

Microsoft consiglia di utilizzare singolare per Enums a meno che non Enumrappresenti i campi bit (utilizzare FlagsAttributeanche il). Vedere Convenzioni di denominazione dei tipi di enumerazione (un sottoinsieme delle Linee guida per la denominazione di Microsoft ).

Per rispondere al tuo chiarimento, non vedo nulla di sbagliato in nessuno dei seguenti casi:

public enum OrderStatus { Pending, Fulfilled, Error };

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

o

public enum OrderStatus { Pending, Fulfilled, Error };

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

Ho iniziato a nominare enum al plurale ma da allora sono diventato singolare. Sembra avere più senso nel contesto in cui vengono utilizzati.

enum Status { Unknown = 0, Incomplete, Ready }

Status myStatus = Status.Ready;

Confrontare con:

Statuses myStatus = Statuses.Ready;

Trovo che la forma singolare suoni più naturale nel contesto. Siamo d'accordo sul fatto che quando dichiariamo l'enum, che accade in un posto, stiamo pensando "questo è un gruppo di whatevers", ma quando lo usiamo, presumibilmente in molti posti, che stiamo pensando "questo è uno qualunque" .

La situazione non si applica mai realmente al plurale.

An enummostra un attributo di qualcosa o un altro. Faccio un esempio:

enum Humour
{
  Irony,
  Sarcasm,
  Slapstick,
  Nothing
}

Puoi avere un tipo, ma prova a pensarlo nel multiplo, piuttosto che nel plurale:

Humour.Irony | Humour.Sarcasm

Piuttosto che

Humours { Irony, Sarcasm }

Hai un senso dell'umorismo, non hai un senso dell'umorismo.

In generale, la raccomandazione delle migliori pratiche è singolare, ad eccezione di quegli enum che hanno l'attributo [Flags] allegato (e che quindi possono contenere campi di bit), che dovrebbero essere al plurale.

Dopo aver letto la tua domanda modificata, ho la sensazione che potresti pensare che il nome della proprietà o il nome della variabile debbano essere diversi dal nome del tipo di enum ... No. Quanto segue è perfettamente bene ...

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

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

Questo è uno dei pochi posti in cui non sono abbastanza d'accordo con la convenzione per andare contro di essa. TBH, ODIO il fatto che la definizione di un enum e l'istanza di esso possano avere lo stesso nome. Postfisso tutti i miei Enum con "Enum" in particolare perché chiarisce qual è il contesto di esso in ogni dato utilizzo. IMO rende il codice molto più leggibile.

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


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

Nessuno confonderà mai qual è l'enum e qual è l'istanza di esso.

Se stai cercando di scrivere un codice semplice, ma proibito come questo:

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

Le tue opzioni sono:

1. Ignora la raccomandazione MS e usa un prefisso o suffisso sul nome dell'enum:

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

2. Spostare la definizione enum all'esterno della classe, preferibilmente in un'altra classe. Ecco una soluzione semplice a quanto sopra:

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

Best practice: utilizzare singolare. Hai un elenco di elementi che compongono un Enum. L'uso di un elemento nell'elenco suona strano quando dici Versions.1_0. Ha più senso dire che Version.1_0esiste solo una versione 1_0.

In arrivo un po 'in ritardo ...

C'è una differenza importante tra la tua domanda e quella che menzioni (che ho chiesto ;-):

Metti la definizione di enum fuori dalla classe, che ti permette di avere lo stesso nome per l'enum e la proprietà:

public enum EntityType { 
  Type1, Type2 
} 

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

}

In questo caso, seguirei le linee guida MS e userò un nome singolare per l'enum (plurale per le bandiere). Probaby è la soluzione più semplice.

Il mio problema ( nell'altra domanda ) è quando l'enum è definito nell'ambito della classe, impedendo l'uso di una proprietà chiamata esattamente dopo l'enum.

Sull'altro thread Convenzione di denominazione C # per enum e corrispondenti proprietà qualcuno ha sottolineato ciò che penso sia un'ottima idea:

"So che il mio suggerimento va contro le convenzioni di denominazione .NET, ma personalmente prefisso enum con 'E' e enum flag con 'F' (simile a come prefiggiamo le interfacce con 'I')."