Convention d'appellation des Enum - Pluriel

Question

Je pose cette question alors que j'ai déjà lu des documents similaires, mais qui ne correspondent pas exactement à ce que je veux. Convention de dénomination C# pour les enum et les propriétés correspondantes

J'ai constaté que j'ai tendance à nommer les enums au pluriel et à les "utiliser" au singulier, par exemple :

public enum EntityTypes {
  Type1, Type2
}

public class SomeClass {
  /*
    some codes
  */

  public EntityTypes EntityType {get; set;}

}

Bien sûr, cela fonctionne et c'est mon style, mais quelqu'un peut-il trouver un problème potentiel avec cette convention ? J'ai cependant un nom "laid" avec le mot "Statut" :

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

public class SomeClass {
  /*
    some codes
  */

  public OrderStatuses OrderStatus {get; set;}

}

Informations supplémentaires : Peut-être que ma question n'était pas assez claire. Je dois souvent réfléchir pour nommer les variables des types d'enum que j'ai définis. Je connais la meilleure pratique, mais cela ne m'aide pas à faciliter la tâche de nommer ces variables.

Je ne peux pas exposer toutes les propriétés de mon enum (disons "Status") comme "MyStatus".

Ma question : Quelqu'un peut-il trouver un problème potentiel avec ma convention décrite ci-dessus ? Il ne s'agit PAS de meilleures pratiques.

Reformulation de la question :

Eh bien, je suppose que je devrais poser la question de cette façon : Quelqu'un peut-il trouver un bon moyen générique de nommer le type d'énumération de telle sorte que, lorsqu'il est utilisé, le nom de l'"instance" de l'énumération soit assez simple ?

Answer 1

Microsoft recommande d'utiliser le singulier pour Enum à moins que le Enum représente des champs de bits (utilisez l'option FlagsAttribute également). Voir Conventions d'appellation des types d'énumération (un sous-ensemble du programme Directives d'attribution de noms ).

Pour répondre à votre précision, je ne vois rien de mal à ce qui suit :

public enum OrderStatus { Pending, Fulfilled, Error };

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

ou

public enum OrderStatus { Pending, Fulfilled, Error };

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

Answer 2

J'ai commencé à nommer les enums au pluriel mais j'ai depuis changé pour le singulier. Cela semble plus logique dans le contexte où ils sont utilisés.

enum Status { Unknown = 0, Incomplete, Ready }

Status myStatus = Status.Ready;

Comparer à :

Statuses myStatus = Statuses.Ready;

Je trouve que la forme singulière sonne plus naturelle dans le contexte. Nous sommes d'accord sur le fait que lorsque nous déclarons l'enum, ce qui n'arrive qu'à un seul endroit, nous pensons "c'est un groupe de choses", mais que lorsque nous l'utilisons, vraisemblablement à de nombreux endroits, nous pensons "c'est une chose".

Answer 3

La situation ne s'applique jamais vraiment au pluriel.

Un site enum montre un attribut de quelque chose ou d'un autre. Je vais vous donner un exemple :

enum Humour
{
  Irony,
  Sarcasm,
  Slapstick,
  Nothing
}

Vous pouvez avoir un seul type, mais essayez d'y penser au multiple, plutôt qu'au pluriel :

Humour.Irony | Humour.Sarcasm

Plutôt que de

Humours { Irony, Sarcasm }

Vous avez le sens de l'humour, vous n'avez pas le sens de l'humour.

Answer 4

En général, la meilleure pratique recommandée est le singulier, sauf pour les enums auxquels l'attribut [Flags] est attaché (et qui peuvent donc contenir des champs de bits), qui doivent être au pluriel.

Après avoir lu votre question, j'ai l'impression que vous pensez que le nom de la propriété ou de la variable doit être différent du nom du type d'enum... Ce n'est pas le cas. Ce qui suit est tout à fait correct...

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

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

Answer 5

Meilleure pratique - utiliser le singulier. Vous avez une liste d'éléments qui constituent une Enum. L'utilisation d'un élément de la liste semble étrange lorsque vous dites Versions.1_0 . Il est plus logique de dire Version.1_0 puisqu'il n'y a qu'une seule version 1_0.