Le enumerazioni in C# dovrebbero avere il loro file?

Question

Ho una classe che utilizza un'enumerazione, l'enum è attualmente nel proprio file che sembra sprecato.

Qual è l'opinione generale sulle enumerazioni inserite nello spazio dei nomi di un file in cui sono consumate? O l'enum dovrebbe davvero vivere nel proprio file CS?

Modifica

Devo dire che, mentre la classe in questione utilizza questi enumerazioni, così fa chiamanti esterni. In altre parole, un'altra classe può impostare queste enumerazioni. Quindi non sono utilizzati internamente alla classe, altrimenti questa domanda sarebbe una cosa da niente.

Answer 1

Non direi "dispendioso" (quanto costa un file in più?), Ma spesso è incongruo. Di solito c'è una classe che è più strettamente associata all'enum e le ho inserite nello stesso file.

Answer 2

Questa è interamente una questione di stile. Quello che tendo a fare è avere un file chiamato Enums.cs nella soluzione in cui sono raccolte le dichiarazioni enum.

Ma in genere si trovano tramite la chiave F12.

Answer 3

Questo è davvero solo una questione di preferenza.

Preferisco mettere ciascuna enumerazione in un proprio file (allo stesso modo per ogni interfaccia, classe e struttura, non importa quanto piccola). Li rende più facili da trovare quando vengo da un'altra soluzione o altrimenti non hanno già un riferimento al tipo in questione.

Inserire un singolo tipo in ogni file facilita l'identificazione delle modifiche nei sistemi di controllo del codice sorgente senza diffondere.

Answer 4

Mi piace avere un file di enumerazione pubblico denominato E contenente ogni enum separato, quindi qualsiasi enum è accessibile con E ... e sono in un posto da gestire.

Answer 5

In genere preferisco che il mio enum sia nello stesso file della classe che probabilmente sarà un attributo di. Se ad esempio ho una classe Task, l'enum TaskStatus sarà nello stesso file.

Tuttavia, se ho enumerazioni di natura più generica, le mantengo contestualmente in vari file.

Answer 6

Penso che dipenda dalla portata dell'enum. Per esempio, se l'enumerazione è specifico per una classe, ad esempio, utilizzato per evitare lo scenario costante magica, allora direi messo nello stesso file della classe:

enum SearchType { Forward, Reverse } 

Se l'enum è generale e può essere usato da più classi per diversi scenari, quindi sarei propenso a metterlo in un suo file. Ad esempio, il seguito potrebbe essere utilizzato per diversi scopi:

enum Result { Success, Error } 

Answer 7

tendo a mettere le enumerazioni nel proprio file per un motivo molto semplice: come con le classi e le strutture, è bello sapere esattamente dove cercare se vuoi trovare la definizione di un tipo: nel file con lo stesso nome. (Per essere onesti, in VS puoi sempre usare anche "Vai alla definizione".)

Ovviamente, può sfuggire di mano.Un collega in cui lavoro produce anche file separati per i delegati.

Answer 8

Posiziono principalmente all'interno del namespace e all'esterno della classe in modo che sia facilmente accessibile altre classi in tale spazio dei nomi come di seguito.

namespace UserManagement 
{ 
    public enum UserStatus { Active, InActive } 
    class User 
    { 
     ... 
    } 
} 

Answer 9

La domanda da porsi sarebbe: c'è nulla di un tipo di censimento nel C# che indica dovrei trattare in modo diverso da tutti gli altri tipi che creo?

Se l'enumerazione è pubblica, deve essere trattata come qualsiasi altro tipo pubblico. Se è privato, dichiararlo come membro annidato della classe che lo utilizza. Non vi è alcun motivo valido per inserire due tipi pubblici nello stesso file semplicemente perché uno è un'enumerazione. Il fatto che sia un tipo pubblico è tutto ciò che conta; il sapore del tipo non lo fa.

Answer 10

Un vantaggio dell'utilizzo di un file separato per l'enumerazione è che è possibile eliminare la classe originale che ha utilizzato l'enum e scrivere una nuova classe utilizzando l'enum.

Se l'enumerazione è indipendente dalla classe originale, inserirla in un file separato facilita le modifiche future.

Answer 11

Un altro vantaggio di mettere ogni tipo (classe, struct, enum) nel proprio file è il controllo del codice sorgente. Puoi facilmente ottenere l'intera cronologia del tipo.

Answer 12

Dipende da quale accesso è necessario.

Se l'enumerazione viene utilizzata solo da una singola classe, è possibile dichiararla all'interno di quella classe perché non è necessario utilizzarla da nessun'altra parte.

Per le enumerazioni utilizzate da più classi o in un'API pubblica, quindi manterrò sempre la definizione nel proprio file nello spazio dei nomi appropriato. È molto più facile trovarlo in questo modo, e la strategia segue lo schema di un oggetto per file, che è buono da usare anche con le classi e le interfacce.

Answer 13

Se si utilizza il componente aggiuntivo USysWare File Browser per Visual Studio, è possibile trovare molto rapidamente file di nomi particolari nella soluzione. Immagina di cercare una enumerazione che non sia nel suo stesso file ma sepolta in qualche file in una gigantesca soluzione.

Per le soluzioni di piccole dimensioni, non importa, ma per le grandi, diventa ancora più importante mantenere le classi e le enumerazioni nei propri file. Puoi trovarli rapidamente, modificarli e altro ancora. Consiglio vivamente di inserire l'enumerazione nel proprio file.

E come è stato detto ... Quanto è sprecato un file che finisce per essere solo un paio di kb lo stesso?

Answer 14

Se si dispone di più progetti in un'unica soluzione. Quindi meglio creare un altro progetto Utilities. Quindi creare una cartella \Enumerations e creare uno static class nidificato. E poi assegna ogni classe statica in cui creerai enum che corrisponde al nome dei tuoi progetti. Per esempio si dispone di un progetto denominato DatabaseReader e DatabaseUsers allora si potrebbe denominare la classe statica come

public static class EnumUtility { 
    #region --Database Readers Enum 
    public static class EnumDBReader { 
     public enum Actions { Create, Retrieve, Update, Delete}; 
    } 
    #endregion 

    #region --Database Users Enum 
    public static class EnumDBUsers { 
     public enum UserIdentity { user, admin }; 
    } 
    #endregion 

} 

Poi intero enum che può essere utilizzato in tutta soluzioni per progetti saranno dichiarati su di esso. Utilizzare # region per separare ogni preoccupazione. Con questo, è più facile cercare eventuali enumerazioni