Czy Enum powinno zaczynać się od 0 czy 1?

Wyobraź sobie, że zdefiniowałem następujący Enum:

public enum Status : byte
{
    Inactive = 1,
    Active = 2,
}

Jaka jest najlepsza praktyka korzystania z wyliczenia? Czy powinien zaczynać się 1od powyższego przykładu, czy od 0(bez jawnych wartości) w następujący sposób:

public enum Status : byte
{
    Inactive,
    Active
}

Wytyczne dotyczące projektowania ram :

✔️ PODAJ wartość zero w przypadku prostych wyliczeń.

Rozważ nazwanie wartości czymś w rodzaju „Brak”. Jeśli taka wartość nie jest odpowiednia dla tego konkretnego wyliczenia, najczęściej używana wartość domyślna wyliczenia powinna mieć wartość bazową zero.

Wytyczne dotyczące projektowania ram / projektowanie wyliczeń flag :

❌ UNIKAJ używania wartości wyliczenia flag o wartości zero, chyba że wartość reprezentuje „wszystkie flagi są wyczyszczone” i ma odpowiednią nazwę, zgodnie z następnymi wytycznymi.

✔️ NALEŻY nazwać zerową wartość wyliczeń flag Brak. W przypadku wyliczenia flag wartość musi zawsze oznaczać „wszystkie flagi są wyczyszczone”.

Cóż, myślę, że nie zgadzam się z większością odpowiedzi, które mówią, że nie należy ich wyraźnie numerować. Zawsze jawnie je numeruję, ale dzieje się tak dlatego, że w większości przypadków ostatecznie utrwalam je w strumieniu danych, gdzie są przechowywane jako wartości całkowite. Jeśli nie dodasz jawnie wartości, a następnie dodasz nową wartość, możesz przerwać serializację, a następnie nie będzie można dokładnie załadować starych utrwalonych obiektów. Jeśli masz zamiar dokonać jakiegokolwiek trwałego przechowywania tych wartości, zdecydowanie polecam jawne ustawienie wartości.

Enum jest typem wartości, a jego wartość domyślna (na przykład dla pola Enum w klasie) będzie wynosić 0, jeśli nie zostanie zainicjowana jawnie.

Dlatego generalnie chcesz mieć 0 jako zdefiniowaną stałą (np. Nieznane).

W twoim przykładzie, jeśli chcesz Inactivebyć wartością domyślną, powinna mieć wartość zero. W przeciwnym razie warto rozważyć dodanie stałej Unknown.

Niektórzy zalecają, aby nie podawać jawnie wartości stałych. Prawdopodobnie w większości przypadków dobra rada, ale w niektórych przypadkach będziesz chciał to zrobić:

• Flagi wyliczenia

• Wyliczenia, których wartości są używane we współpracy z systemami zewnętrznymi (np. COM).

Jeśli nie masz konkretnego powodu, aby to zmienić, pozostaw wyliczenia z ich domyślnymi wartościami, które zaczynają się od zera.

public enum Status : byte
{
    Inactive,
    Active
}

Powiedziałbym, że najlepszą praktyką jest nie numerowanie ich i pozostawienie ich w domyśle - co zacznie się od 0. Ponieważ jest to niejawne, to preferencja językowa, którą zawsze dobrze jest przestrzegać :)

Zacząłbym wyliczenie typu boolowskiego od 0.

Chyba że „Nieaktywny” oznacza coś innego niż „Nieaktywny” :)

To zachowuje standard dla tych.

Powiedziałbym, że to zależy od tego, jak ich używasz. Przy oznaczaniu wyliczenia dobrą praktyką jest przyjmowanie Nonewartości 0 dla wartości, na przykład:

[Flags]
enum MyEnum
{
    None = 0,
    Option1 = 1,
    Option2 = 2,
    Option3 = 4,
    All = Option1 | Option2 | Option3,
}

Gdy prawdopodobnie wyliczenie zostanie zmapowane do tabeli wyszukiwania bazy danych, zacznę od 1. Nie powinno to mieć większego znaczenia dla profesjonalnie napisanego kodu, ale poprawia to czytelność.

W innych przypadkach zostawiłbym to tak, jak jest, nie dbając o to, czy zaczynają się od 0, czy 1.

O ile nie masz dobrego powodu, aby używać surowych wartości, powinieneś zawsze używać niejawnych wartości i odwoływać się do nich za pomocą Status.Activei Status.Inactive.

Problem polega na tym, że możesz chcieć przechowywać dane w pliku prostym lub bazie danych albo użyć pliku płaskiego lub bazy danych utworzonej przez kogoś innego. Jeśli robisz to sam, zrób to tak, aby numeracja była zgodna z tym, do czego służy Enum.

Jeśli dane nie są twoje, oczywiście będziesz chciał użyć tego, co pierwotny programista użył jako schematu numeracji.

Jeśli planujesz używać Enum jako zestawu flag, istnieje prosta konwencja, której warto przestrzegać:

enum Example
{
  None      = 0,            //  0
  Alpha     = 1 << 0,       //  1
  Beta      = 1 << 1,       //  2
  Gamma     = 1 << 2,       //  4
  Delta     = 1 << 3,       //  8
  Epsilon   = 1 << 4,       // 16
  All       = ~0,           // -1
  AlphaBeta = Alpha | Beta, //  3
}

Wartości powinny być potęgami dwójki i mogą być wyrażone przy użyciu operacji przesunięcia bitowego. Noneoczywiście powinno 0, ale Alljest to mniej oczywiste -1. ~0jest binarną negacją 0i skutkuje liczbą, dla której każdy bit jest ustawiony na 1, który reprezentuje wartość-1 . W przypadku flag złożonych (często używanych dla wygody) inne wartości mogą być łączone przy użyciu operatora bitowego lub |.

Nie przypisuj żadnych numerów. Po prostu używaj go tak, jak powinien być używany.

Jeśli nie zostanie określony, numeracja zaczyna się od 0.

Ważne jest, aby być jawnym, ponieważ wyliczenia są często serializowane i przechowywane jako int, a nie ciąg.

Dla każdego wyliczenia przechowywanego w bazie danych zawsze jawnie numerujemy opcje, aby zapobiec przenoszeniu i ponownemu przypisywaniu podczas konserwacji.

Według firmy Microsoft zalecaną konwencją jest użycie pierwszej opcji zerowej do reprezentowania niezainicjowanej lub najczęściej używanej wartości domyślnej.

Poniżej znajduje się skrót do rozpoczynania numeracji od 1 zamiast 0.

public enum Status : byte
{
    Inactive = 1,
    Active
}

Jeśli chcesz ustawić wartości flag w celu użycia operatorów bitowych na wartościach wyliczeniowych, nie rozpoczynaj numerowania od wartości zerowej.

Jeśli zaczniesz od 1, możesz łatwo policzyć swoje rzeczy.

{
    BOX_THING1     = 1,
    BOX_THING2     = 2,
    BOX_NUM_THING  = BOX_THING2
};

Jeśli zaczniesz od 0, użyj pierwszej jako wartości dla rzeczy niezainicjowanych.

{
    BOX_NO_THING   = 0,
    BOX_THING1     = 1,
    BOX_THING2     = 2,
    BOX_NUM_THING  = BOX_THING2
};

Po pierwsze, jeśli nie określasz konkretnych wartości z jakiegoś powodu (wartość liczbowa ma znaczenie gdzie indziej, np. Baza danych lub usługa zewnętrzna), nie określaj w ogóle wartości liczbowych i pozwól im być jawne.

Po drugie, zawsze powinieneś mieć element o wartości zerowej (w wyliczeniach bez flag). Ten element będzie używany jako wartość domyślna.

Nie rozpoczynaj ich od 0, chyba że jest ku temu powód, na przykład używanie ich jako indeksów do tablicy lub listy, lub jeśli istnieje inny praktyczny powód (np. Używanie ich w operacjach bitowych).

Twój enumpowinien zacząć dokładnie tam, gdzie powinien. Nie musi też być sekwencyjny. Wartości, jeśli są wyraźnie określone, muszą odzwierciedlać pewne znaczenie semantyczne lub praktyczne rozważania. Na przykład enum„butelki na ścianie” powinny być ponumerowane od 1 do 99, podczas gdy enumdla potęg 4 powinno się prawdopodobnie zaczynać od 4 i kontynuować od 16, 64, 256 itd.

Ponadto dodanie elementu o wartości zerowej do elementu enumnależy wykonać tylko wtedy, gdy reprezentuje prawidłowy stan. Czasami „brak”, „nieznany”, „brak” itp. Są prawidłowymi wartościami, ale często tak nie jest.

Lubię zaczynać wyliczenia od 0, ponieważ jest to ustawienie domyślne, ale lubię też dodawać nieznaną wartość o wartości -1. To wtedy staje się domyślne i może czasami pomóc w debugowaniu.