Cómo nombrar archivos fuente C# para las clases genéricas

Question

Estoy tratando de apegarme a las convenciones generales de nomenclatura como las que se describen en Design Guidelines for Developing Class Libraries. Puse cada tipo en su propio archivo fuente (y las clases parciales se dividirán en varios archivos como se describe en la pregunta Naming Conventions for Partial Class Files), usando el nombre del tipo como el nombre del archivo.

Ejemplos:

namespace Demo.Bla       // project 
{ 
    enum FlowDirection { }     // in file FlowDirection.cs 
    class LayoutManager { }    // in file LayoutManager.cs 
} 

namespace Demo.Bla.LayoutControllers  // folder LayoutControllers in project 
{ 
    class StackPanelLayoutController { } // in file LayoutControllers/StackPanelLayoutController 
} 

Pero no estoy seguro de que he llegado con una forma inteligente de nombrar los archivos de origen que contienen las clases genéricas. Decir que tengo después de clases, por ejemplo:

namespace Demo.Bla.Collections    // folder Collections 
{ 
    class Map<T> { }      // in file Map.cs (obviously) 
    class Bag { }       // in file Bag.cs (obviously) 
    class Bag<T> : Bag { }     // also in file Bag.cs ??? 
} 

¿Debo poner el código tanto de la no-genérico y los genéricos Bag clases en el mismo archivo Bag.cs? ¿Cuáles son tus hábitos?

Answer 1

En el repositorio CoreFX GitHub, Microsoft está siguiendo la convención back-garrapata se describe en respuesta Matthias Jakobsson 's:

Así que, básicamente:

class ImmutableArray { }      // ImmutableArray.cs 
class ImmutableArray<T> { }     // ImmutableArray`1.cs 
... 
class ImmutableDictionary<TKey, TValue> { } // ImmutableDictionary`2.cs 

Y para clases definidas dentro de otras clases, el nombre está compuesto por clase externa seguida por + y por el nombre de la clase interna (Outer+Inner.cs):

partial class ImmutableArray<T>    // ImmutableArray`1+Builder.cs 
{ 
    class Builder { } 
} 

Answer 2

Por lo general, si tengo varios tipos "sobrecargados" por el número de parámetros de tipo, es porque uno deriva del otro o uno se usa para crear el otro. Simplemente los puse en el mismo archivo.

Una opción alternativa sería dividirlos en archivos diferentes, hacer que un archivo sea el "primario" y los otros "dependan" del archivo de compilación, según la pregunta de clase parcial a la que se vinculó en la pregunta .

De esta manera podría terminar con un enlace visual en Visual Studio, pero aún así una clase por archivo para que sea más fácil trabajar con ellos.

Answer 3

Agrego un sufijo 'T' a los nombres de mis clases genéricas.

class Bag { }       // in file Bag.cs 
class BagT<T> : Bag { }     // in file BagT.cs 
class BagInputs : BagT<Input>   // in file BagInputs.cs 

Usted preguntó,

¿Debo poner el código tanto de la no genérica y las clases Bolsa genéricos en el mismo archivo Bag.cs? ¿Cuáles son tus hábitos?

La anterior convención mía no es estándar; Debo aclarar que estaba respondiendo "cuáles son mis hábitos" y no necesariamente "lo que debes hacer".

Answer 4

Creo que la solución común a este problema es nombrar el archivo de la siguiente manera:

{ClassName}`{NumberOfGenericParameters} 

Esto le daría a este nombre de archivo:

Bag.cs and Bag`1.cs 

Ésta es la forma en que Microsoft manejar esta cuestión en marcos como Asp.net Mvc.

Answer 5

he visto algunas bibliotecas utilizando

Bag.cs 
Bag`1.cs 
Bag`2.cs 

ya que esto es lo que podría mostrar la Type.Name.

Quiero ser más descriptivo con los parámetros de tipo así que últimamente tienden a utilizar

Bag.cs 
Bag{T}.cs 
Bag{TKey, TValue}.cs 

Este es un formato que también es apoyado por los comentarios XML.

/// <summary> 
/// ... 
/// Uses the <see cref="T:MyLibrary.Bag{TKey, TValue}" /> class. 
/// </summary>