枚舉命名約定 - 複數

Question

我問，儘管看了相似，但這個問題不正是我想在C# naming convention for enum and matching property

我發現我有一種傾向，名稱多枚舉，然後「用」他們爲單數，例如：

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」。

我的問題：任何人都可以發現潛在的問題與上述我的約定？ 這不是最佳做法。

問題重新整理：

嗯，我想我應該問這樣的問題：有人能出來命名枚舉類型的一個很好的通用的方法，例如在使用時，枚舉的命名「實例'將非常簡單？

Answer 1

微軟建議Enum S使用單數，除非Enum代表位字段（使用FlagsAttribute爲好）。請參閱Enumeration Type Naming Conventions（微軟的Naming Guidelines的子集）。

要你的澄清迴應，我認爲沒有錯用下面的：

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

一般而言，除了那些具有[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 3

我開始了命名複數枚舉但此後改爲單數。只是在使用它們的地方似乎更有意義。

enum Status { Unknown = 0, Incomplete, Ready } 

Status myStatus = Status.Ready; 

對比：

Statuses myStatus = Statuses.Ready; 

我覺得單數形式的聲音在上下文中更自然。我們同意，當在一個地方聲明枚舉時，我們認爲「這是一羣凡是」，但是當使用它時，可能在很多地方，我們認爲「這是一個什麼」 。

Answer 4

最佳實踐 - 使用單數。你有一個組成Enum的項目列表。當您說Versions.1_0時，使用列表中的項目聽起來很奇怪。因爲只有一個1_0版本，所以說Version.1_0更有意義。

Answer 5

這種情況從來都不適用於複數形式。

enum顯示某個屬性或另一個屬性。我舉一個例子：

enum Humour 
{ 
    Irony, 
    Sarcasm, 
    Slapstick, 
    Nothing 
} 

你可以有一個類型，但在多嘗試想起來了，而不是複數：

Humour.Irony | Humour.Sarcasm

不是

Humours { Irony, Sarcasm }

你有幽默感，你沒有幽默感。

Answer 6

在其他線程C# naming convention for enum and matching property有人指出，我認爲是一個很好的主意：

「我知道我的建議違背了.NET命名約定，但我個人前綴枚舉與‘E’和枚舉標誌與'F'（類似於我們如何在'I'前加接口'）「。」

Answer 7

即將在有點晚了......

有你的問題和一個you mention（我問;-)之間的一個重要區別：

你把枚舉定義出來的類，它讓你擁有的枚舉和屬性相同的名字：

public enum EntityType { 
    Type1, Type2 
} 

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

} 

在這種情況下，我會按照MS guidelins和枚舉（複數爲標誌）使用奇異的名字。這是最簡單的解決方案。

我的問題（在other question）是當枚舉在類的範圍內定義時，阻止使用在枚舉之後完全命名的屬性。

Answer 8

如果你試圖寫簡單，但禁止這樣的代碼：

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推薦和使用前綴或後綴的枚舉名：

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

2. 將枚舉定義移到類之外，最好是進入另一個班級。下面是一個簡單的解決方案上面：

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

Answer 9

這是我與約定足夠去反對它不同意的幾個地方之一。 TBH，我暗示枚舉的定義和它的實例可以有相同的名稱。我用「Enum」特別後綴所有的枚舉，因爲它明確了它在任何給定用法中的上下文。海事組織使得代碼更具可讀性。

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


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

沒有人會混淆枚舉和什麼是實例。