Convención para nombres de archivo de clases genéricas

Question

Quiero ser capaz de distinguir entre una versión genérica y una versión normal (no genérica) de una clase. Al igual que el .NET Framework hace con sus versiones genéricas y no genéricas de varias de sus interfaces y clases de colección. (Queue, Queue(T))

Generalmente me gusta seguir la convención de una clase por archivo (como en Java). ¿Existe una convención común para nombrar archivos que contengan una sola clase genérica? Estoy interesado principalmente en Windows (NTFS específicamente) pero parece que una buena convención sería (al menos un poco) portátil.

Answer 1

En Microsoft, que utilizan ClassNameOfT.cs

Answer 2

¿Qué tal:

Type.cs 

y

TypeGeneric.cs 

Cada vez que he hecho esto en el pasado siempre he poner los dos tipos en un archivo con el tipo no genérico como el nombre del archivo. Creo que esto deja las cosas bastante claras ya que .NET no tiene convenciones/restricciones en un tipo por archivo como lo hace Java.

Pero si debe, entonces sugeriría algo como lo que tengo arriba, y usar un sufijo hará que los archivos se muestren juntos en cualquier lista alfabética (Solution Explorer, Windows Explorer, etc.).

Aquí es otra idea:

Type`1.cs 

Esto permitirá romper a cabo diferentes tipos genéricos por el número de parámetros de tipo genérico que aceptaron. Sin embargo, es sólo un pensamiento, ya que todavía creo que sería más simple poner todos los tipos en un solo archivo.

Answer 3

Probablemente tenga dos carpetas en el proyecto, algo así como Gereric, NonGeneric o algo así. Todavía pueden estar en el mismo espacio de nombres, y luego ambos pueden tener el mismo nombre de archivo. Solo un pensamiento ...

Answer 4

Todas las clases nuevas de Microsoft usan genéricos. El Queue y ArrayList estaban allí antes de que salieran los genéricos. Los genéricos son el camino a seguir.

La convención para el archivo de una clase por archivo es nombrar el nombre del archivo después del nombre de la clase (si es genérico de no). Para MyClass, tendrás MyClas.cs. Para cada nuevo espacio de nombres necesitarás crear una nueva carpeta. Así es como funciona Visual Studio.

Answer 5

Probablemente los pondría en carpetas y usaría el mecanismo del espacio de nombres en su lugar. Puede comparar con System.Collections vs. System.Collections.Generic. Por otro lado, si es más común que no que las clases usen genéricos, quizás sea mejor señalar aquellas que no lo son. Eso es si realmente desea separar las clases genéricas de otras clases. Personalmente, normalmente no me molesto en hacer eso, ya que realmente no veo un beneficio práctico de ello.

Answer 6

De las respuestas hasta ahora parece que no hay consenso.

Usando el mismo nombre de archivo en un espacio de nombres secundario (y subcarpeta) "Generics" (como System.Collecctions.Generics) es una opción. Pero no siempre es deseable crear un nuevo espacio de nombres.

Por ejemplo, en un espacio de nombres existente con clases no genéricas que se mantienen por compatibilidad con versiones anteriores, pero marcadas con ObsoleteAttribute, es probable que sea mejor mantener las versiones genéricas en el mismo espacio de nombres.

Creo que un sufijo es una forma razonable de hacerlo. He adoptado una convención de usar los parámetros de tipo como sufijo (por lo que: MyClassT para MiClase < T> o MyDictionaryKV para MyDictionary < K, V>

Answer 7

Justo.. encontré esta pregunta después de buscar lo convenciones otras personas utilizan para nombres de archivo de clases genéricas

Últimamente he estado usando ClassName[T].cs me gusta mucho esta convención, y yo creo que es superior a los demás por las siguientes razones:..

• Los parámetros de tipo brindan un poco más de que con la convención de Microsoft (por ejemplo, ClassNameOfT.cs).
• Se le permite tener múltiples parámetros tipo sin demasiada confusión : Dictionary[TKey, TValue].cs
• que no requiere que usted para crear las carpetas especiales, o para tener sus clases genéricas en un espacio de nombres especial. Si solo tiene unas pocas clases genéricas, tener un espacio de nombre especial dedicado a ellas simplemente no es práctico.

I prestado esta convención de sintaxis genérica Boo 's, aunque ligeramente modificado (Boo utiliza ClassName[of T]).

Algunos desarrolladores parecen tener una fobia a los nombres de archivos que contienen cualquier cosa menos letras y guiones bajos, pero una vez que se puede pasar, esta convención parece funcionar extremadamente bien.

Answer 8

No utilice el acento grave 'en los nombres de archivo genérico si se está ejecutando Visual Studio 2008. Hay un problema conocido con ellos que hace que los puntos de interrupción para fallan:

http://connect.microsoft.com/VisualStudio/feedback/details/343042/grave-accent-in-filename-causes-failure-to-recognize-target-language-breakpoints-fail

Answer 9

veo que este tema ha sido abandonado hace más de un año, pero aún así me gustaría compartir mi punto de vista sobre esta convención.

En primer lugar, tener múltiples clases que tengan el mismo nombre pero solo difieran en la cantidad de parámetros de tipo no siempre es un caso de compatibilidad con versiones anteriores. Seguramente, no lo ve muy a menudo, pero las nuevas clases de Action y Func de .NET se diseñaron de esta manera, y actualmente estoy implementando algo similar.

Para mayor claridad y distinguibilidad, uso la siguiente convención que sólo especifica el número de argumentos genéricos para un tipo dado:

• MyClass.cs
• MyClass.T1.cs
• MyClass.T2 .cs

De esta forma, mis nombres de archivo permanecen cortos y simples a la vez que comunican claramente el nombre de clase y la cantidad diferente de parámetros de tipo a costa de un simple punto extra (que es, en mi experiencia, una cosa comúnmente aceptada para hacer en un nombre de archivo y se ve mucho mejor que las comas y otros caracteres no alfanuméricos, pero esto es solo una cuestión de gusto, supongo).Poner los nombres (o acrónimos) de los parámetros de tipo simplemente alarga los nombres de los archivos, mientras que en este nivel no estoy realmente interesado en los nombres reales de los parámetros de tipo ...

Answer 10

Personalmente, no usaría el acento grave Notación:

Foo.cs 
Foo`1.cs 

Por la sencilla razón de que tengo miedo del acento grave. No solo tiene un nombre aterrador, pero no estoy seguro de cómo será manejado por los diferentes sistemas de archivos, sistemas de control de versiones y en las URL. Por lo tanto, preferiría mantener los caracteres alfanuméricos comunes.

NameOfT.cs parece ser utilizado en ASP.NET Core MVC según una búsqueda en GitHub. 12 resultados Reference.

También uso limitado en CoreFX. 3 resultados Reference.

Ejemplo:

Foo.cs 
FooOfT.cs