Estándares De Desarrollo En Aplicaciones .Net

Estándares de Desarrollo
en Aplicaciones .NET


Ayacucho, 10 de agosto de 2010











Tabla de Contenido

Introducción 4
I. Codificación 5
1. Notación 5
2. Definición, su Ámbito o Alcance 5
3. Definición de Variables 5
4. Definición de Constantes 6
5. Definición de Enumeradores 6
6. Definición de una Clase 6
7. Definición de Propiedades de una Clase 78. Definición de Métodos de una Clase y Funciones 7
9. Módulos vs Clases 8
10. Definición de una Interface 8
11. Recomendaciones Adicionales 9
II. Administración de Código 10
1. Nombre de Assemblies 10
2. Organización de proyectos 10
3. Definición de proyectos 10
4. Documentación de Código 11
5. Documentación de Clases, Funciones o Procedimientos 12
6. Documentaciónde Modificación a Código ya Existente 12
III. Definición de Objetos en .NET 13
1. Windows Forms 13
2. Web Forms 14
3. Objetos ADO.NET 14
4. Comentarios 15
5. Regiones de código 16





Introducción



En el presente documento se definirán los estándares de programación para las Aplicaciones .NET bajo las 3 Capas de Desarrollo de Aplicaciones: Presentación, Reglas deNegocio y Acceso a Datos.

Asimismo, el presente documento pretende ser una Guía General de Estándares para el desarrollo de toda Aplicación basada en Tecnología .NET.


Codificación


1. Notación

▪ Usar la notación Pascal, la primera letra de cada palabra en mayúscula y el resto en minúscula.
Ejemplo: ColorFondo



2. Definición, su Ámbito o Alcance


▪ No usarprefijos de ámbito.


▪ Las variables, constantes, procedimientos y funciones deben ser definidas con el menor alcance posible.



3. Definición de Variables

▪ En VB.NET Forzar la declaración de todas las variables en cada archivo
Ejemplo: Option Explicit On


▪ Usar Nombres descriptivos en Castellano
Ejemplo: montoTotal


▪ No usar de underscore ounderline "_"


▪ No crear variables solo diferenciadas por la capitalización
Ejemplo: nombre, NOMBRE


▪ Agregar el prefijo en minúsculas "m" SOLO a variables privadas de clases (Atributos):
Ejemplo: mEdad


▪ No usar prefijo de ámbito


▪ En VB.NET no usar el signo “+” para concatenar cadenas, usar el signo “&”, y en situaciones más complejas,System.Text.StringBuilder


▪ Escoger el tipo de dato correcto para reducir los requerimientos de memoria, incrementar la velocidad de ejecución y reducir los errores.


▪ Se debe usar el tipo de dato Object solo cuando sea absolutamente necesario.


▪ Usar la propiedad Length de los tipos de datos String para determinar si una variable está vacía.
Ejemplo:


C#:
if(Nombre.Length == 0)
{
///...
}



4. Definición de Constantes

▪ Usar Nombres descriptivos en Castellano
Ejemplo: NOMBRE_APLICACION


▪ Usar SOLO en este caso el underscore o underline "_"


▪ Usar SOLO en este caso la notación Uppercase
Ejemplo: ANCHO_FORMULARIO


▪ No usar prefijo de ámbito


▪ Escoger el tipo de dato correcto parareducir los requerimientos de memoria, incrementar la velocidad de ejecución y reducir los errores.



5. Definición de Enumeradores

▪ Usar enumeradores cuando los parámetros acepten un número predefinido de valores


Ejemplo:
C#:
enum AviFileType
{
FileCopy = 0,
FileDelete = 1,
};


private voidShowAviFile(AviFileType TipoArchivoAvi)
{
///...
}


6. Definición de una Clase

▪ Usar la notación Pascal para el nombramiento de Clases
Ejemplo: Usuario


▪ No agregar prefijos
Ejemplo: Empleado, CuentaCorriente


▪ No usar nombres que existan en .Net Framework
Ejemplo: Forms


▪ Emplear private para los procedimientos o funciones que no...