Estandar De Desarollo

Estándares de Desarrollo

Versión 1.0



Fecha de confección: 01/03/2008
Título: Estándares de Desarrollo
Temática: Aplicativos .NET



Clasificación: Público
Auditorio: Medusa Desarrollo















Confeccionado por: Gerardo Medina

Modificación 17/02/09: Gabriel Cerutti


Revisado por:
Gabriel Cerutti
Martín Herran
Agustín Ordoñez
Leonardo SpataroObjetivos

El propósito del presente documento es describir la normativa de codificación a respetar para los desarrollos de aplicativos en .NET



Alcance

Esta normativa es aplicable a todo desarrollo de aplicaciones en .NET, ya sea internas de Medusa o Tercerizadas.



Elaboración / Revisión / Aprobación

El presente documento es elaborado por Gerardo Medina, Revisado por losmiembros de la dirección y aprobado por la misma.

Descripción del Estándar

1. Introducción
Uno de los instrumentos que facilitan el desarrollo de software y que influye en la mejora de calidad del mismo es la adopción de estándares de estilo y codificación.
Es por esto que la codificación de los módulos del Sistema a desarrollar debe cumplir ciertos requisitos, detallados en el presentedocumento.

El uso de estos estándares tiene innumerables ventajas, entre ellas:
▪ Asegurar la legibilidad del código entre distintos programadores, facilitando el debugging del mismo.
▪ Proveer una guía para el encargado de mantenimiento / actualización del sistema, con código claro y bien documentado.
▪ Facilitar la portabilidad entre plataformas y aplicaciones.

Toda aplicación.NET debe cumplir los estándares que se presentan en las siguientes secciones.

2. Boxing y unboxing
Conceptos y Ejemplos
Boxing: Conversión de un tipo determinado a un Object
Unboxing: Conversión del tipo Object a un tipo determinado
▪ Toda estructura deriva de System.Object
▪ Toda estructura puede declararse como Object.
▪ La conversión a su tipo original no es directa ya queexisten diferencias semánticas y de almacenamiento.

El Boxing y el Unboxing son procesos lentos e implican la creación y destrucción de objetos envoltorios.
Definición 1: Boxing y Unboxing
Esta técnica se podrá utilizar sólo en casos consensuados con el responsable del producto y/o Jefe de Desarrollo, según corresponda.

3. Requerimientos Generales
Conceptos y Ejemplos
• El lenguaje deProgramación C# (C Sharp) o Visual Basic .Net. Se aconseja la utilización de C# para todo lo que es el BackEnd y VB Net para las aplicaciones FrontEnd.
• Deben evitarse nombres imprecisos que permitan interpretaciones subjetivas, como por ejemplo DefinirEsto(), o bien ytG8 para una variable. Tales nombres contribuyen más a la ambigüedad que a la abstracción.
• En POO es redundante incluir nombresde clases en el nombre de las propiedades de clases, como por ejemplo Rectangulo.RectanguloArea, en su lugar, utilice Rectangulo.Area, pues el nombre de la clase ya denota dicha información
• Utilice la técnica verbo-sustantivo para nombrar procedimientos que ejecuten alguna operación en un determinado objeto, como por ejemplo
CalcularSaldo().
• Es recomendado que las variable boleanas contenganuna palabra que describa su estado: puedeEliminarse, esGrande, tieneHijos, etc. Y siempre se debe referir al estado verdadero: tieneCredito en cambio de noTieneCredito.
• Se aconseja el uso de comentarios en línea para facilitar la comprensión del código, sobre todo en procedimientos complejos. Los comentarios pueden ser con fin documental o bien como 'ayuda-memoria'.
Definición 2:Requerimientos Generales:
• Se puede utilizar siempre C# (C Sharp) o VB (Visual Basic)
• No incluir nombres de clases en el nombre de las propiedades de las clases.
• Todo procedimiento debe ser nombrado utilizando la técnica verbo-sustantivo.
• Toda variable booleana debe nombrarse describiendo su estado.

4. Variables y Constantes
Conceptos y Ejemplos
Notación prefijos de ámbito + Húngara:
• Esta...