Enum命名约定-复数

我问这个问题，尽管读过类似的，但不完全是我想在c#命名约定enum和匹配属性

我发现我倾向于用复数来命名枚举，然后用单数来“使用”它们，例如:

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;}

}

额外的信息: 也许我的问题还不够清楚。在为我所定义的枚举类型的变量命名时，我经常需要认真思考。我知道最佳实践，但这无助于减轻我命名这些变量的工作。

我不能暴露我所有的枚举属性(说“状态”)为“MyStatus”。

我的问题:有人能发现上面描述的约定的潜在问题吗?这与最佳实践无关。

问题改述:

好吧，我想我应该这样问这个问题:有人能想出一个很好的通用方式命名枚举类型，这样在使用时，命名枚举“实例”将非常直接?

当前回答

微软建议使用单数Enum，除非Enum表示位字段(也可以使用FlagsAttribute)。参见枚举类型命名约定(微软命名指南的一个子集)。

就你的澄清，我认为以下任何一条都没有问题:

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; }
}

2009-09-10 15:08:23

其他回答

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

在阅读了你编辑的问题后，我有一种感觉，你可能认为属性名或变量名必须与枚举类型名不同……它不是。下面的内容完全没问题……

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

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

2009-09-10 15:08:05

这是少数几个我不同意公约的地方之一，足以反对它。TBH，我讨厌枚举的定义和它的实例可以有相同的名字。我把所有的枚举都加上了“Enum”，因为它清楚地表明了它在任何给定用法中的上下文。在我看来，这让代码可读性更强。

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


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

没有人会混淆什么是enum，什么是它的实例。

2017-12-05 21:52:10

这种情况从来不适用于复数。

枚举显示某物的属性。我举个例子:

enum Humour
{
  Irony,
  Sarcasm,
  Slapstick,
  Nothing
}

你可以有一种类型，但试着用复数来思考，而不是复数:

幽默。讽刺幽默。讽刺

而不是

幽默{讽刺，讽刺}

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

2009-09-10 15:13:35

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

2009-09-10 15:12:19

微软建议使用单数Enum，除非Enum表示位字段(也可以使用FlagsAttribute)。参见枚举类型命名约定(微软命名指南的一个子集)。

就你的澄清，我认为以下任何一条都没有问题:

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; }
}

2009-09-10 15:08:23

Enum命名约定-复数

推荐文章

最新文章

标签