Convenciones y Estándares de Nombres

canaldenegocio.com Informes Internos (no divulgar) Resumen de Arquitecturas, Metodologías y Buenas Prácticas by Alberto Fernández. 1 de 49

Estándares de Codificación en C# y

Buenas Prácticas de Programación

@canaldenegociocanaldenegocio.com Informes Internos (no divulgar) Resumen de Arquitecturas, Metodologías y Buenas Prácticas by Alberto Fernández. 2 de 49

Contenido

Introducción. ....................................................................................................................................... 4

2. Convenciones y Estándares de Nombres .................................................................................... 5

3. Sangría y Espaciamiento ............................................................................................................ 10

4. Buenas prácticas de programación ........................................................................................... 14

5. Arquitectura .............................................................................................................................. 25

Acceso a Datos ¿Code handle, dataset tipados, Entity…? ........................................................ 30

6. UI (ergonomía de interface de usuario) .................................................................................... 37

7. ASP.NET ..................................................................................................................................... 38

¿Qué CDN me conviene utilizar? ............................................................................................... 39

¿MVC o no MVC? .......................................................................................................................... 40

8. Smartphones ............................................................................................................................. 44

9. Comentarios .............................................................................................................................. 45

10. Manejo de Excepciones ......................................................................................................... 46 canaldenegocio.com Informes Internos (no divulgar) Resumen de Arquitecturas, Metodologías y Buenas Prácticas by Alberto Fernández. 3 de 49

Este documento es una versión Draft.

Todos los derechos de distribución son de canaldenegocio.com

Todos los derechos del contenido, pertenece a sus creadores.

De uso interno, prohibida su difusión. canaldenegocio.com Informes Internos (no divulgar) Resumen de Arquitecturas, Metodologías y Buenas Prácticas by Alberto Fernández. 4 de 49

Introducción.

Documento basado en metodologías de Microsoft + Metodologías Agiles.

Para mantener un buen nivel de cumplimiento de buenas prácticas, al finalizar un Sprint (en la retrospectiva), debes realizar reuniones de revisión de código para asegurar que cada uno está siguiendo las reglas. Tres tipos de revisiones de código son recomendadas:

a. Peer Review: Revisión por un Par – otro miembro del equipo revisa el código asegurándose de que el código sigue los estándares de codificación y cumple los requerimientos. Este nivel de revisión puede incluir además algunas pruebas unitarias. Cada archivo en el proyecto debe pasar por este proceso.

b. Revisión del Arquitecto – el arquitecto del equipo debe revisar los módulos principales del proyecto para asegurarse de que se adhieren al diseño y que no haya “grandes” errores que puedan afectar el proyecto en el largo plazo.

c. Revisión Grupal – aleatoriamente se selecciona uno o más archivos y se conduce una revisión de grupo finalizado un Sprint. Distribuye una copia impresa de los archivos a todos los miembros 30 minutos antes de la reunión. Permite que la lean y que lleguen con puntos de discusión. En la reunión para la revisión grupal, usa un proyecto para desplegar el contenido del archivo en la pantalla. Navega por cada una de las secciones del código y permite que cada miembro dé sus sugerencias en cómo esa pieza de código podría ser escrita de mejor manera. (No olvides apreciar al desarrollador por el buen trabajo y asegúrate de que no se sienta ofendido por el “ataque de grupo”)

canaldenegocio.com Informes Internos (no divulgar) Resumen de Arquitecturas, Metodologías y Buenas Prácticas by Alberto Fernández. 5 de 49

2. Convenciones y Estándares de Nombres

Nota: Los términos “notación Pascal” y “notación de Camell” son usados a través de este documento

Notación Pascal – El primer carácter de todas las palabras se escribe en Mayúsculas y los otros caracteres en minúsculas.

Ejemplo: ColorDeFondo

Notación de Camell – El primer carácter de todas las palabras, excepto de la primera palabra se escribe en Mayúsculas y los otros caracteres en minúsculas.

Ejemplo: colorDeFondo

1. Usa notación Pascal para el nombre de las Clases

public class HolaMundo

{

…

}

2. Usa notación Pascal para el nombre de los Métodos

void DiHola(string nombre)

{

…

}

3. Usa notación de Camell para variables

...