枚举命名约定 - 复数

Question

尽管我在 枚举和匹配属性的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;}

}

附加信息： 也许我的问题不够清楚。在命名我定义的枚举类型的变量时，我经常必须认真思考。我知道最佳实践，但这无助于减轻我命名这些变量的工作。

我不可能将所有枚举属性（例如“Status”）公开为“MyStatus”。

我的问题：任何人都可以发现我上述约定的潜在问题吗？ 这与最佳实践无关。

问题改述：

好吧，我想我应该这样问问题：有人能想出一种很好的通用方法来命名枚举类型，例如使用时，枚举“实例”的命名会非常简单吗？

Answer 1

Microsoft 建议对 Enum 使用单数，除非 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; }
}

Answer 2

我一开始用复数命名枚举，但后来改为单数。在它们的使用环境中似乎更有意义。

enum Status { Unknown = 0, Incomplete, Ready }

Status myStatus = Status.Ready;

比较：

Statuses myStatus = Statuses.Ready;

我发现单数形式在上下文中听起来更自然。我们一致认为，当声明发生在一个地方的枚举时，我们会想到“这是一组无论什么”，但是当使用它时，大概是在许多地方，我们会想到“这是一个无论如何” 。

Answer 3

这种情况实际上并不适用于复数。

enum 显示某事物的属性。我举一个例子：

enum Humour
{
  Irony,
  Sarcasm,
  Slapstick,
  Nothing
}

思考它：

你可以有一种类型，但尝试以倍数而不是复数的形式来 Humour.Sarcasm

而不是

Humours { Irony, Sarcasm }

你有幽默感，你没有幽默感。

Answer 4

这是我不同意该公约足以反对它的少数几个地方之一。说实话，我讨厌枚举的定义和它的实例可以具有相同的名称。我在所有枚举后面加上“Enum”，因为它清楚地表明了它在任何给定用法中的上下文。 IMO 它使代码更具可读性。

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


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

没有人会混淆什么是枚举和什么是它的实例。

Answer 5

一般来说，最佳实践建议是单数，除了那些附加了 [Flags] 属性的枚举（因此可以包含位字段），它们应该是复数。

阅读您编辑的问题后，我感觉您可能认为属性名称或变量名称必须与枚举类型名称不同......事实并非如此。下面的就完全没问题了...

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

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

Answer 6

如果您尝试编写如下所示的简单但禁止的代码：

    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 建议并在枚举名称上使用前缀或后缀：

   公共类 Person
   {
       公共枚举 GenderEnum
       {
           男性，
           女性
       }
       公共 GenderEnum 性别 { 获取；放; }
   }
   

2. 将枚举定义移到类之外，最好移到另一个类中。这是上述问题的一个简单解决方案：

   公共课特点
   {
       公共枚举性别
       {
           男性，
           女性
       }
   }
   公开课人物
   {
       公共特征.性别 性别 { get;放; }  
   }
   

Answer 7

最佳实践 - 使用单数。您有一个组成枚举的项目列表。当您说 Versions.1_0 时，使用列表中的项目听起来很奇怪。说 Version.1_0 更有意义，因为只有一个 1_0 版本。

Answer 8

来得有点晚了...

您的问题与

你将枚举定义放在类之外，这允许你为枚举和属性使用相同的名称：

public enum EntityType { 
  Type1, Type2 
} 

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

}

在这种情况下，我会遵循MS 指南并为枚举使用单数名称（标志为复数名称）。这可能是最简单的解决方案。

我的问题（在其他问题中）是当枚举在类的范围内定义，防止使用完全以枚举命名的属性。

Answer 9

在枚举声明中使用复数的原因是（在声明时）我们用多个值声明它，所以复数似乎很好......
但我们忽略了这样一个事实：枚举在声明时指定了它可以具有什么值（来自给定的值集）。这并不意味着该枚举的实例将存储多个值......
当我们写：
枚举天数 { MON, TUE, WED, THU, FRI, SAT, SUN};
我们将其设为复数，因为提供了多个值。
然而，当使用（Days day = Days.MON;）时，我们完全忽略该枚举的实例应该具有单个值......
所以当我们写：
枚举 Day { MON, TUE, WED, THU, FRI, SAT, SUN };
我们的意思是有一个枚举可以将任意一天作为其值，因此单数更合适。
虽然（上面已经描述过），要在不使用单数名称的情况下解决这个问题，可以使用任何类型的指标，例如 DayEnum 或 EDay（我更喜欢第二种）....

Answer 10

在另一个线程上 枚举和匹配属性的 C# 命名约定有人指出我认为这是一个非常好的主意：

“我知道我的建议违反了 .NET 命名约定，但我个人在枚举前加上“E”前缀，在枚举标志前加上“F”（类似于我们在接口前加上“”）我'）。”