sábado, 2 de agosto de 2014

.NET: REGLAS PARA NOMBRAR PROYECTOS

EL PROBLEMA

Microsoft no nos da ninguna orientación sobre la forma de nombrar a nuestros proyectos y por lo tanto deja en manos del desarrollador. El estilo de nomenclatura que se muestra en la Figura 1 funciona bien en pequeños proyectos.

Figura 1 - OK

Sin embargo, a medida que se van añadiendo más capas, la complejidad crece y lo mismo ocurre con la confusión del desarrollador cuando no se nombran a los proyectos de forma coherente. (Ver Figura 2)




Figura 2 - Convención de nomenclatura inconsistente


LA FORMA CORRECTA

Mientras que Microsoft ha mantenido en silencio sobre este tema, no hemos dejado de notar la forma en que se nombran dlls. Por ejemplo vemos System.Windows.Forms.dll.
Partiendo del ejemplo y extendiendo un paso más nombraremos a las soluciones teniendo en cuenta la siguiente estructura: Compañia.NombreSolucion y para proyectos de la siguiente manera Compañia.NombreSolucion.NombreProyecto  
(Ver Figura 3)



Figura 3 - Convención de nomenclatura consistente

Con este estilo, podemos identificar fácilmente los distintos proyectos que comprenden esta solución y de dónde venían. También nos libera de la preocupación que surge cuando una solución es necesario hacer referencia a dos proyectos a partir de dos soluciones diferentes con el mismo nombre.
Se recomienda contar con su compañía como el elemento raíz del espacio de nombres. Esto ayuda a aclarar espacio de nombres al que pertenecen, de dónde viene y además que es único (o al menos razonablemente único). Al crear estos espacios de nombres, el pensamiento razonable se debe dar con el fin de crear un espacio de nombres con sentido. Tenga en cuenta que los espacios de nombres se distingue entre mayúsculas y minúsculas (abc.framework y ABC.Framework no son la misma cosa).
Copyright © 2014 Trujillo - Perú