Konvensi Penamaan Enum - Jamak

Saya mengajukan pertanyaan ini meskipun telah membaca yang serupa tetapi tidak persis apa yang saya inginkan di konvensi penamaan C # untuk enum dan properti yang cocok

Saya menemukan bahwa saya memiliki kecenderungan untuk menyebut enum dalam bentuk jamak dan kemudian 'menggunakannya' sebagai singular, contoh:

public enum EntityTypes {
  Type1, Type2
}

public class SomeClass {
  /*
    some codes
  */

  public EntityTypes EntityType {get; set;}

}

Tentu saja itu berhasil dan ini adalah gaya saya, tetapi adakah yang bisa menemukan masalah potensial dengan konvensi semacam itu? Saya memiliki nama "jelek" dengan kata "Status":

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

public class SomeClass {
  /*
    some codes
  */

  public OrderStatuses OrderStatus {get; set;}

}

Info Tambahan: Mungkin pertanyaan saya tidak cukup jelas. Saya sering harus berpikir keras ketika menyebutkan variabel dari tipe enum yang saya tentukan. Saya tahu praktik terbaik, tetapi itu tidak membantu untuk memudahkan pekerjaan saya memberi nama variabel-variabel itu.

Saya tidak mungkin mengekspos semua properti enum saya (katakan "Status") sebagai "MyStatus".

Pertanyaan saya: Adakah yang bisa menemukan masalah potensial dengan konvensi saya yang dijelaskan di atas? Ini BUKAN tentang praktik terbaik.

Ulangi pertanyaan:

Nah, saya kira saya harus mengajukan pertanyaan seperti ini: Dapatkah seseorang keluar cara generik yang baik untuk penamaan tipe enum sehingga ketika digunakan, penamaan enum 'instance' akan sangat mudah?

Microsoft merekomendasikan untuk menggunakan singular untuk Enums kecuali Enummewakili bidang bit (gunakan FlagsAttributejuga). Lihat Konvensi Penamaan Jenis Pencacahan (bagian dari Pedoman Penamaan Microsoft ).

Untuk menanggapi klarifikasi Anda, saya melihat tidak ada yang salah dengan salah satu dari berikut ini:

public enum OrderStatus { Pending, Fulfilled, Error };

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

atau

public enum OrderStatus { Pending, Fulfilled, Error };

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

Saya mulai memberi nama enum dalam bentuk jamak tetapi sejak itu berubah menjadi tunggal. Sepertinya lebih masuk akal dalam konteks di mana mereka digunakan.

enum Status { Unknown = 0, Incomplete, Ready }

Status myStatus = Status.Ready;

Dibandingkan dengan:

Statuses myStatus = Statuses.Ready;

Saya menemukan bentuk tunggal terdengar lebih alami dalam konteks. Kami sepakat bahwa ketika mendeklarasikan enum, yang terjadi di satu tempat, kami berpikir "ini adalah kelompok barang apa pun", tetapi ketika menggunakannya, mungkin di banyak tempat, bahwa kami berpikir "ini adalah apa pun" .

Situasi tidak pernah benar-benar berlaku untuk jamak.

Suatu enummenunjukkan atribut dari sesuatu atau yang lain. Saya akan memberi contoh:

enum Humour
{
  Irony,
  Sarcasm,
  Slapstick,
  Nothing
}

Anda dapat memiliki satu jenis, tetapi coba pikirkan dalam beberapa, bukan jamak:

Humour.Irony | Humour.Sarcasm

Daripada

Humours { Irony, Sarcasm }

Anda memiliki selera humor, Anda tidak memiliki selera humor.

Secara umum, rekomendasi praktik terbaik adalah tunggal, kecuali untuk enum yang memiliki atribut [Bendera] yang melekat padanya, (dan yang karenanya dapat berisi bidang bit), yang harus jamak.

Setelah membaca pertanyaan Anda yang diedit, saya merasa Anda mungkin berpikir nama properti atau nama variabel harus berbeda dari nama tipe enum ... Tidak. Berikut ini baik-baik saja ...

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

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

Ini adalah salah satu dari sedikit tempat yang saya tidak setuju dengan konvensi yang cukup untuk menentangnya. TBH, SAYA BENCI bahwa definisi enum dan turunannya dapat memiliki nama yang sama. Saya mem-postfix semua Enum saya dengan "Enum" secara khusus karena itu memperjelas konteksnya dalam penggunaan apa pun. IMO itu membuat kodenya jauh lebih mudah dibaca.

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


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

Tidak ada yang akan pernah bingung apa enum dan apa contohnya.

Jika Anda mencoba untuk menulis secara langsung, kode yang dilarang seperti ini:

    public class Person
    {
        public enum Gender
        {
            Male,
            Female
        }
        //Won't compile: auto-property has same name as enum
        public Gender Gender { get; set; }  
    }

Pilihan Anda adalah:

1. Abaikan rekomendasi MS dan gunakan awalan atau akhiran pada nama enum:

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

2. Pindahkan definisi enum di luar kelas, lebih disukai ke kelas lain. Berikut ini adalah solusi mudah untuk hal di atas:

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

Praktik Terbaik - gunakan tunggal. Anda memiliki daftar item yang membentuk Enum. Menggunakan item dalam daftar terdengar aneh ketika Anda mengatakannya Versions.1_0. Lebih masuk akal untuk mengatakan Version.1_0karena hanya ada satu Versi 1_0.

Datang agak terlambat ...

Ada perbedaan penting antara pertanyaan Anda dan yang Anda sebutkan (yang saya tanyakan ;-):

Anda menempatkan definisi enum dari kelas, yang memungkinkan Anda untuk memiliki nama yang sama untuk enum dan properti:

public enum EntityType { 
  Type1, Type2 
} 

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

}

Dalam hal ini, saya akan mengikuti pedoman MS dan menggunakan nama tunggal untuk enum (jamak untuk bendera). Ini mungkin solusi termudah.

Masalah saya (dalam pertanyaan lain ) adalah ketika enum didefinisikan dalam ruang lingkup kelas, mencegah penggunaan properti yang dinamai persis setelah enum.

Di thread lain konvensi penamaan C # untuk enum dan properti yang cocok seseorang menunjukkan apa yang saya pikir adalah ide yang sangat bagus:

"Saya tahu saran saya bertentangan dengan konvensi Penamaan .NET, tetapi saya secara pribadi awalan enum dengan 'E' dan enum flag dengan 'F' (mirip dengan bagaimana kita awali Antarmuka dengan 'I')."