Acerca de las Guías
En esta serie encontraremos guias para:
- Implementar una convención de nombres apropiada
- Diseño de Tipos
- Diseño adecuado de los miembros de un tipo
- Crear componentes que puedan ser extendidos utilizando diferentes mecanismos como por ejemplo, eventos, miembros virtuales, miembros abstractos, etc.
- Manejo de excepciones para el reporte de errores
- Extender y utilizar los tipos comunes en las APIs publicas
- Implementar algunos de los patrones de diseño más comunes, por ejemplo el patrón Dispose y propiedades de dependencia (dependency Properties).
Contenido de la Guía para implementar una convención de nombres apropiada
El contenido de esta guía consta de 6 lecciones.
Lección 1. Convenciones sobre el uso de mayúsculas y minúsculas
Dado que el CLR soporta distintos lenguajes que podrían o no ser sensibles a mayúsculas y minúsculas, no es recomendable utilizar una combinación de mayúsculas y minúsculas con el fin de diferenciar nombres de identificadores. Sin embargo, la importancia del uso de mayúsculas y minúsculas para mejorar la legibilidad de los nombres no debe ser exagerada.
Las guías de esta lección exponen un método sencillo para el uso de mayúsculas y minúsculas que, cuando se aplica de manera consistente, hace que los identificadores de tipos, miembros y parámetros sean fáciles de leer.
Al finalizar esta lección, los participantes podrán::
- Describir las reglas recomendadas de uso apropiado de mayúsculas y minúsculas en los nombres de identificadores
- Utilizar apropiadamente la notación PascalCasing y camelCasing.
- Capitalizar apropiadamente acrónimos y palabras compuestas.
Lección 2. Convenciones generales sobre nombres
Esta lección describe las convenciones generales de nomenclatura que se relacionan con la elección de palabras, directrices sobre el uso de abreviaturas y acrónimos, así como recomendaciones de cómo evitar el uso de nombres específicos del lenguaje.
Al finalizar esta lección, los participantes podrán:
- Elegir palabras apropiadas para los nombres de identificadores.
- Identificar los casos de uso de acrónimos y abreviaciones.
- Entender la importancia de evitar el uso de nombres específicos del lenguaje para los nombres de identificadores.
- Utilizar nombres apropiados para versiones nuevas de APIs existentes.
Lección 3. Nombres de ensamblados, DLLs y espacios de nombres
En esta lección se describen las convenciones de nomenclatura para ensamblados, DLLs y espacios de nombres. Se describe también la forma de evitar conflictos de nombres similares de tipos que residen en espacios de nombres distintos.
Al finalizar esta lección, los participantes podrán:
- Describir la nomenclatura recomendada para nombrar ensamblados y DLLs.
- Describir la nomenclatura para nombrar espacios de nombres.
- Identificar los conflictos de nombres de tipos similares en espacios de nombres distintos.
Lección 4. Nombres de Clases, Estructuras e Interfaces
En esta lección se describen las recomendaciones para la nomenclatura de Clases, Estructuras e Interfaces. Se describe también la nomenclatura para los parámetros de tipo en los tipos genéricos personalizados y las enumeraciones.
Al finalizar esta lección, los participantes podrán:
- Seleccionar el nombre apropiado para Clases, Estructuras, Interfaces y Enumeraciones.
- Seleccionar el nombre apropiado para los parámetros de tipo.
- Seleccionar nombres apropiados para tipos que derivan o implementan tipos predefinidos.
Lección 5. Nombres de miembros de tipos
Los tipos están conformados por miembros: métodos, propiedades, eventos, constructores y campos. En esta lección se describen las guías para nombrar los miembros de tipos.
Al finalizar esta lección, los participantes podrán:
- Elegir nombres apropiados para los métodos, propiedades, eventos y campos de un tipo.
Lección 6. Nombres de Parámetros y Recursos
En esta lección se describe la nomenclatura para establecer nombres apropiados a parámetros de métodos, así como la nomenclatura para establecer nombres a los identificadores de los recursos utilizados dentro de la aplicación.
Al finalizar esta lección, los participantes podrán:
- Nombrar adecuadamente los parámetros de métodos.
- Nombrar adecuadamente los identificadores de recursos.