Czy nazwy plików Enum mają być poprzedzone przyrostkiem "Enum"?

Question

Podczas dzielenia klas na pliki, zastanawiam się, czym jest konwencja nazewnictwa dla plików klas zawierających tylko wyliczenia. Czy powinny pasować do nazwy wyliczeniowej, tak jak każdej innej klasy, czy też powinny mieć przyrostek "Enum", aby deweloper wiedział, że plik zawiera tylko wyliczenie?

Na przykład:

namespace MyCompanyName.MyApplication 
{ 
    public enum Colors 
    { 
     Red, 
     Blue, 
     Green, 
     Yellow 
    } 
} 

powiedziałbyś plik zawierający powyższy kod powinien być nazwany 'Colors.cs' lub 'ColorsEnum.cs'? Alternatywnie, być może istnieje inna akceptowana konwencja nazewnictwa dla takich plików?

Answer 1

Po pierwsze, jest to całkowicie osobista preferencja osobista/zespołowa.

takiej sytuacji:

Osobiście go Colors.cs nazwać. Zachowuje to nazwę pliku odpowiadającą nazwie typu. Kiedy pracuję nad API, jeśli "Kolory" są ustalonym zbiorem rzeczy reprezentowanych przez enum, prawdopodobnie bym to wiedział i nie byłoby żadnego zamieszania.

Answer 2

Co z tworzeniem folderu o nazwie Wylicza i nazywanie pliku Colors.cs?

Answer 3

Nazwa pliku moim zdaniem powinna być taka sama jak nazwa wyliczenia, które - zgodnie z Enum Naming guidelines powinien nie mają przyrostek Enum. Również wytyczne sugerują Twój enum powinny być pojedynczej więc zarówno biorąc pod uwagę powinno być Color.cs

Answer 4

Tworzenie folderu o nazwie Wyliczenia, wyliczenia lub coś opisowe powinno wystarczyć. Ponadto można śledzić C# nazewnictwa standardów stwierdzili, że:.

„Nazwy Wyliczenia Nie używaj prefiks nazw wartości wyliczenie Na przykład, nie należy używać prefiksu takich jak reklamy dla wyliczenia ADO lub rtf dla bogatych wyliczenia tekst, i tak dalej.

oznacza to również, że nie powinien zawierać nazwę typu wyliczenie w nazwach wartość wyliczenia. Poniższy przykład kodu demonstruje nieprawidłowo nazywania wartości wyliczenie za.

kod C# następująco

public enum Teams 
{ 
    TeamsAlpha, 
    TeamsBeta, 
    TeamsDelta 
} 

Referencje: Names of Classes, Structs, and Interfaces