Enum Naming Convention - Plural

Ich stelle diese Frage, obwohl ich ähnlich gelesen habe, aber nicht genau das, was ich bei der C # -Namenskonvention für Aufzählung und übereinstimmende Eigenschaft möchte

Ich habe festgestellt, dass ich die Tendenz habe, Enums im Plural zu benennen und sie dann als Singular zu verwenden. Beispiel:

public enum EntityTypes {
  Type1, Type2
}

public class SomeClass {
  /*
    some codes
  */

  public EntityTypes EntityType {get; set;}

}

Natürlich funktioniert es und das ist mein Stil, aber kann jemand ein potenzielles Problem mit einer solchen Konvention finden? Ich habe allerdings eine "hässliche" Benennung mit dem Wort "Status":

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

public class SomeClass {
  /*
    some codes
  */

  public OrderStatuses OrderStatus {get; set;}

}

Zusätzliche Informationen: Vielleicht war meine Frage nicht klar genug. Ich muss oft nachdenken, wenn ich die Variablen meiner definierten Aufzählungstypen benenne. Ich kenne die Best Practice, aber es hilft mir nicht, diese Variablen leichter zu benennen.

Ich kann unmöglich alle meine Enum-Eigenschaften (sagen wir "Status") als "MyStatus" verfügbar machen.

Meine Frage: Kann jemand ein potenzielles Problem mit meiner oben beschriebenen Konvention finden? Es geht NICHT um Best Practice.

Umformulierung der Frage:

Nun, ich denke, ich sollte die Frage folgendermaßen stellen: Kann jemand eine gute generische Methode finden, um den Aufzählungstyp so zu benennen, dass die Benennung der Aufzählungsinstanz bei Verwendung ziemlich einfach ist?

Microsoft empfiehlt die Verwendung von Singular für Enums, es sei denn, das Enumstellt Bitfelder dar (verwenden Sie auch das FlagsAttribute). Siehe Aufzählungstyp Namenskonventionen (eine Untergruppe von Microsofts Richtlinien zur Benennung ).

Um auf Ihre Klarstellung zu antworten, sehe ich nichts Falsches an den folgenden Punkten:

public enum OrderStatus { Pending, Fulfilled, Error };

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

oder

public enum OrderStatus { Pending, Fulfilled, Error };

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

Ich habe angefangen, Enums im Plural zu benennen, bin aber seitdem zu Singular gewechselt. Scheint nur im Zusammenhang mit dem Verwendungszweck sinnvoller zu sein.

enum Status { Unknown = 0, Incomplete, Ready }

Status myStatus = Status.Ready;

Vergleichen mit:

Statuses myStatus = Statuses.Ready;

Ich finde, dass die Singularform im Kontext natürlicher klingt. Wir sind uns einig, dass wir bei der Deklaration der Aufzählung, die an einem Ort stattfindet, denken, "dies ist eine Gruppe von was auch immer", aber wenn wir sie verwenden, vermutlich an vielen Orten, denken wir, "dies ist was auch immer". .

Die Situation trifft nie wirklich auf den Plural zu.

An enumzeigt ein Attribut von etwas oder einem anderen. Ich werde ein Beispiel geben:

enum Humour
{
  Irony,
  Sarcasm,
  Slapstick,
  Nothing
}

Sie können einen Typ haben, aber versuchen Sie, ihn im Vielfachen und nicht im Plural zu betrachten:

Humour.Irony | Humour.Sarcasm

Eher, als

Humours { Irony, Sarcasm }

Sie haben einen Sinn für Humor, Sie haben keinen Sinn für Humor.

Im Allgemeinen ist die Best-Practice-Empfehlung Singular, mit Ausnahme der Aufzählungen, denen das Attribut [Flags] zugeordnet ist (und die daher Bitfelder enthalten können), die Plural sein sollten.

Nach dem Lesen Ihrer bearbeiteten Frage habe ich das Gefühl, dass der Name der Eigenschaft oder der Variable vom Namen des Aufzählungstyps abweichen muss. Das Folgende ist vollkommen in Ordnung ...

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

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

Dies ist einer der wenigen Orte, an denen ich mit der Konvention nicht einverstanden bin, um dagegen zu verstoßen. TBH, ich hasse es, dass die Definition einer Aufzählung und die Instanz derselben den gleichen Namen haben können. Ich postfixiere alle meine Enums mit "Enum", weil dadurch klar wird, welchen Kontext es in einer bestimmten Verwendung hat. IMO macht es den Code viel lesbarer.

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


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

Niemand wird jemals verwirren, was die Aufzählung ist und was die Instanz davon ist.

Wenn Sie versuchen, einfachen, aber verbotenen Code wie diesen zu schreiben:

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

Ihre Optionen sind:

1. Ignorieren Sie die MS-Empfehlung und verwenden Sie ein Präfix oder Suffix für den Namen der Aufzählung:

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

2. Verschieben Sie die Aufzählungsdefinition außerhalb der Klasse, vorzugsweise in eine andere Klasse. Hier ist eine einfache Lösung für das oben Gesagte:

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

Best Practice - Verwenden Sie Singular. Sie haben eine Liste von Elementen, aus denen eine Aufzählung besteht. Die Verwendung eines Elements in der Liste klingt seltsam, wenn Sie sagen Versions.1_0. Es ist sinnvoller zu sagen, Version.1_0da es nur eine 1_0-Version gibt.

Kommt etwas spät ...

Es gibt einen wichtigen Unterschied zwischen Ihrer und der von Ihnen erwähnten Frage (die ich gestellt habe ;-):

Sie haben die Aufzählungsdefinition aus der Klasse entfernt, sodass Sie für die Aufzählung und die Eigenschaft denselben Namen haben können:

public enum EntityType { 
  Type1, Type2 
} 

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

}

In diesem Fall würde ich den MS-Richtlinien folgen und einen singulären Namen für die Aufzählung verwenden (Plural für Flags). Es ist wahrscheinlich die einfachste Lösung.

Mein Problem (in der anderen Frage ) ist, wenn die Aufzählung im Bereich der Klasse definiert wird, wodurch die Verwendung einer Eigenschaft verhindert wird, die genau nach der Aufzählung benannt ist.

Auf der anderen Thread- C # -Namenskonvention für Enum und Matching-Eigenschaft jemand darauf hingewiesen, was ich für eine sehr gute Idee halte:

"Ich weiß, dass mein Vorschlag gegen die .NET-Namenskonventionen verstößt, aber ich persönlich stelle Enums mit 'E' und Enum-Flags mit 'F' voran (ähnlich wie wir Interfaces mit 'I' voranstellen)."