Marcos Ponce


Estándares de Programación C#

Índice

1.Introducción iii
1.1.Nomenclatura iii
2.Convenciones y Estándares de Nombres 5
3.Sangría y Espaciamiento 10
4.Buenas prácticas de programación 14
5.Arquitectura 22
6.Acceso a Datos 25
7.ASP.NET 26
8.Comentarios 28
9.Manejo de Excepciones 29
1. Introducción
Para mantener un buen nivel de cumplimiento de buenas prácticas, al finalizar unSprint, se deben 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 algunaspruebas 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 unarevisió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 sugerenciasen cómo esa pieza de código podría ser escrita de mejor manera.

1.1. Nomenclatura
Algunas de las nomenclaturas utilizadas dentro de este documento son:
Concepto
Descripción
Notación Pascal
El primer carácter de todas las palabras se escribe en Mayúsculas y los otros caracteres en minúsculas.
Ej.: ColorDeFondo.
Notación de Camell
El primer carácter de todas las palabras, excepto de laprimera palabra se escribe en Mayúsculas y los otros caracteres en minúsculas.
Ej.: colorDeFondo.
Notación Húngara


La cual especifica el tipo de dato de la variable como un prefijo en el nombre y usar el prefijo m_ para variables globales.
Ej.: string m_sNombre;

2. Convenciones y Estándares de Nombres
1. Usar notación Pascal para el nombre de las Clases

public class HolaMundo
{…
}

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

void DiHola(string nombre)
{
…
}

3. Usar notación de Camell para variables y parámetros de los métodos

int cuentaTotal = 0;
void DiHola(string nombre)
{

string mensajeCompleto = “Hola “ + nombre;
…
}

4. Usar el prefijo “I” con notación Pascal para las interfaces (Ejemplo: IEntity). Utilizar “T” paraestructuras de tipos de datos .

public class TFactura {
public String NombreDelCliente;
(…)
public ArrayList LineasDeDetalle = new ArrayList();
}

5. Usar palabras entendibles y descriptivas para nombrar a las variables. No se deben usar abreviaciones.

Correcto:
string direccion;
int salario;

Incorrecto:
string nom;
string domic;
int sal;

6. No usar nombres devariables de un solo carácter como i, n, s etc. Es recomendable usar nombres como indice, temp

Una excepción en este caso podría ser las variables usadas para iteraciones en los ciclos:

for ( int i = 0; i < cantidad; i++)
{
…
}

Si la variable es usada solo como un contador para una iteración y no es usada en ningún otro lado dentro del ciclo, es posible nombrar la variablecon un solo carácter (i) en vez de usar un nombre adecuado distinto.

7. No usar guiones bajos (_) para nombres de variables locales.

8. Utilizar notación Húngara para representar variables globales, usando el prefijo m_ ya que permite identificar fácilmente una variable global.


9. No usar palabras reservadas para nombres de variables.

10. Usa el prefijo “Is” para variables...