อนุสัญญาการตั้งชื่อ Enum - พหูพจน์

ฉันถามคำถามนี้แม้ว่าจะอ่านคล้ายกัน แต่ไม่ตรงกับสิ่งที่ฉันต้องการในหลักการตั้งชื่อ C # สำหรับคุณสมบัติ enum และการจับคู่

ฉันพบว่าฉันมีแนวโน้มที่จะตั้งชื่อ enums เป็นพหูพจน์แล้ว 'ใช้' พวกเขาเป็นเอกพจน์ตัวอย่าง:

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

}

ข้อมูลเพิ่มเติม: บางทีคำถามของฉันอาจไม่ชัดเจนเพียงพอ ฉันมักจะต้องคิดอย่างหนักเมื่อตั้งชื่อตัวแปรของประเภท enum ที่ฉันกำหนด ฉันรู้วิธีปฏิบัติที่ดีที่สุด แต่ก็ไม่ได้ช่วยให้งานของฉันง่ายขึ้นในการตั้งชื่อตัวแปรเหล่านั้น

ฉันไม่สามารถเปิดเผยคุณสมบัติ enum ทั้งหมดของฉัน (พูดว่า "สถานะ") เป็น "MyStatus"

คำถามของฉัน: ใครสามารถพบปัญหาที่อาจเกิดขึ้นกับการประชุมของฉันอธิบายไว้ข้างต้น? มันไม่เกี่ยวกับแนวปฏิบัติที่ดีที่สุด

การใช้ถ้อยคำใหม่ในคำถาม:

ฉันคิดว่าฉันควรถามคำถามด้วยวิธีนี้: ใครบางคนสามารถใช้วิธีการตั้งชื่อประเภท enum ได้ดีเมื่อใช้งานการตั้งชื่อของตัวอย่างของ enum จะค่อนข้างตรงไปตรงมา

Microsoft ขอแนะนำให้ใช้เอกพจน์สำหรับEnums เว้นแต่ว่าจะ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; }
}

ฉันเริ่มตั้งชื่อ enums ในพหูพจน์ แต่หลังจากเปลี่ยนเป็นเอกพจน์ ดูเหมือนว่าจะสมเหตุสมผลมากขึ้นในบริบทของการใช้งาน

enum Status { Unknown = 0, Incomplete, Ready }

Status myStatus = Status.Ready;

เปรียบเทียบกับ:

Statuses myStatus = Statuses.Ready;

ฉันพบว่ารูปแบบเอกพจน์ให้เสียงที่เป็นธรรมชาติมากขึ้นในบริบท เราเห็นพ้องกันว่าเมื่อประกาศ enum ซึ่งเกิดขึ้นในที่เดียวเราคิดว่า "นี่คือกลุ่มของผู้รู้เห็น" แต่เมื่อใช้มันน่าจะเป็นในหลาย ๆ ที่เรากำลังคิดว่า "นี่คือสิ่งที่" .

สถานการณ์ไม่ได้ใช้กับพหูพจน์อย่างแท้จริง

enumแสดงแอตทริบิวต์ของบางสิ่งบางอย่างหรืออื่น ฉันจะให้ตัวอย่าง:

enum Humour
{
  Irony,
  Sarcasm,
  Slapstick,
  Nothing
}

คุณสามารถมีได้หนึ่งประเภท แต่ลองคิดในหลาย ๆ แบบมากกว่าพหูพจน์:

Humour.Irony | Humour.Sarcasm

ค่อนข้างมากกว่า

Humours { Irony, Sarcasm }

คุณมีอารมณ์ขันคุณไม่มีอารมณ์ขัน

โดยทั่วไปคำแนะนำวิธีปฏิบัติที่ดีที่สุดคือเอกพจน์ยกเว้นสำหรับ enums ที่มีแอตทริบิวต์ [Flags] ติดอยู่ (ซึ่งอาจมีเขตข้อมูลบิต) ซึ่งควรเป็นพหูพจน์

หลังจากอ่านคำถามที่แก้ไขแล้วของฉันฉันรู้สึกว่าคุณอาจคิดว่าชื่อคุณสมบัติหรือชื่อตัวแปรต้องแตกต่างจากชื่อประเภท enum ... ไม่ ต่อไปนี้เป็นอย่างดี ...

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

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

นี่เป็นหนึ่งในไม่กี่แห่งที่ฉันไม่เห็นด้วยกับการประชุมที่จะต่อต้านมัน TBH ฉันเกลียดที่คำจำกัดความของ enum และอินสแตนซ์ของมันสามารถมีชื่อเดียวกันได้ ฉัน postfix Enums ทั้งหมดของฉันด้วย "Enum" โดยเฉพาะเพราะทำให้ชัดเจนว่าบริบทของมันอยู่ในการใช้งานใด ๆ IMO ทำให้โค้ดอ่านได้ง่ายขึ้น

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


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

ไม่มีใครเคยสับสนสิ่งที่เป็น enum และสิ่งที่เป็นตัวอย่างของมัน

หากคุณกำลังพยายามที่จะเขียนตรงไปตรงมา แต่รหัสที่ต้องห้ามเช่นนี้:

    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 และใช้คำนำหน้าหรือคำต่อท้ายกับชื่อ enum:

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

2. ย้ายนิยาม enum นอกคลาสโดยควรเป็นคลาสอื่น นี่เป็นวิธีแก้ไขปัญหาที่ง่ายกว่า

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

วิธีปฏิบัติที่ดีที่สุด - ใช้เอกพจน์ คุณมีรายการสิ่งของที่ทำขึ้นเป็น Enum Versions.1_0ใช้รายการในรายการเสียงแปลกเมื่อคุณพูด มันสมเหตุสมผลมากกว่าที่จะพูดVersion.1_0เนื่องจากมีเพียง 1_0 เวอร์ชั่นเดียว

มาช้า ...

มีความแตกต่างที่สำคัญระหว่างคำถามของคุณกับคำถามที่คุณพูดถึง (ซึ่งฉันถาม ;-):

คุณใส่นิยาม enum ออกจากคลาสซึ่งอนุญาตให้คุณมีชื่อเดียวกันสำหรับ enum และคุณสมบัติ:

public enum EntityType { 
  Type1, Type2 
} 

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

}

ในกรณีนี้ฉันจะทำตามแนวทาง MS และใช้ชื่อเอกพจน์สำหรับ enum (พหูพจน์สำหรับธง) มันเป็นเรื่องง่ายที่สุดสำหรับการแก้ปัญหา

ปัญหาของฉัน (ในคำถามอื่น ๆ ) คือเมื่อกำหนด enum ในขอบเขตของคลาสป้องกันการใช้คุณสมบัติที่มีชื่อหลังจาก enum

ในหัวข้อการตั้งชื่อเธรดC # สำหรับ enum และการจับคู่คุณสมบัติบางคนชี้ให้เห็นสิ่งที่ฉันคิดว่าเป็นความคิดที่ดีมาก:

"ฉันรู้ว่าคำแนะนำของฉันนั้นขัดกับอนุสัญญาการตั้งชื่อ. NET แต่ฉันก็เติมคำนำหน้าด้วยตัวอักษร 'E' และ enum flag ด้วย 'F' (คล้ายกับวิธีที่เรานำหน้าส่วนต่อประสานกับ 'I')"