Estandar de Codificacion

Infocorp
Estándares de codificación para C#
Instructivo
October de 2013
Este documento describe los estándares de codificación para C# utilizados en el Departamento de Desarrollo.Este documento describe los estándares de codificación para C# utilizados en el Departamento de Desarrollo.

Archivo:
abc0db1dd6a1a8c8109108959331b239.doc
Páginas:
36
Fecha:
3/2/2007 15:24:00 a3/p3
Autor:Silvia Nane
Contacto:
silvian@infocorp.com.uy
Versión
3
Tabla de contenido
Estándares de codificación para C# 1
Tabla de contenido 2
Introducción 3
Objetivo 3
Alcance 3
Condiciones de uso de este documento 3
Convenciones utilizadas en este documento 3
Terminología y definiciones 4
Fuentes de información consultadas 4
Guía Rápida 5
Convenciones de nomenclatura 5
Estilos decodificación 6
Convenciones de nomenclatura 8
Guías genéricas de nomenclatura 8
Comentarios y Documentación Embebida 13
Guías para la escritura de comentarios 13
Guías para la escritura de documentación embebida 13
Ciclo de vida de Los objetos 14
Guías para la declaración e inicialización de variables 14
Guías para la utilización de destructors de clases 15
Control de Flujo 18
Guías para el usode variables dentro de sentencias loop 18
Guías para el uso de sentencias de control 18
Guías para la Programación de Clases 19
Acerca del uso de propiedades y métodos 19
Guías para el uso de Propiedades 20
Guías para el uso de Eventos 21
Guías para el uso de Métodos 23
Guías para el uso de Constructores 26
Guías para el uso de Atributos 27
Guías para el uso de Parámetros 30
Tipos deDatos 32
Estilo de codificación 34
Apéndice 1 – Tabla de Palabras Reservadas 35

Introducción
Este documento describe reglas y recomendaciones para el desarrollo de aplicaciones utilizando el lenguaje C# en el Departamento de Desarrollo de Infocorp.
La información aquí contenida proviene de varias fuentes, las cuales se listan en el Apéndice 1: Bibliografía consultada.
Específicamente, estedocumento contiene:
Convenciones de nomenclatura
Estilo de codificación
Uso del lenguaje
Diseño de modelos de objetos.
Objetivo
El principal objetivo de la utilización de estándares de codificación, es institucionalizar buenas prácticas y recomendaciones de diseño, para lograr mayores niveles de calidad en los productos de software desarrollados en el Departamento de Desarrollo.
La utilizaciónde estándares debe mostrar efectos positivos sobre:
Disminución de errores / bugs, especialmente en aquellos difíciles de individualizar.
Mantenimiento del código estructurado de acuerdo a las guías de diseño.
Mantenimiento del código escrito de acuerdo a un estilo estandarizado.
Performance de la aplicación desarrollada con prácticas eficientes del lenguaje.

Alcance
Este documento aplicaúnicamente al lenguaje C# y .Net Framework Common Type Systems (CTS). No se incluyen referencias o prácticas relacionadas al uso de las bibliotecas de clases de .Net Framework. Se incluyen algunos comentarios acerca de prácticas comunes y problemas conocidos de C#, las cuales se describen en forma breve.
Dado que las prácticas recomendadas en este manual se aplicarán en forma institucional, sehan incluido normas que describen el uso de llaves ( {} ) y tabulaciones, para lograr una lectura uniforme del código generado en Infocorp.
Condiciones de uso de este documento
Una regla puede romperse sólo ante razones justificadas, discutidas, con previa autorización del responsable del producto, y en caso que no pueda aplicarse ninguna alternativa razonable. El autor de la excepción,obligatoriamente debe documentar el código explicando la causa de la violación de la regla.
Las preferencias personales no se consideran una razón justificada.
Convenciones utilizadas en este documento
Colores y énfasis
Descripción
Azul
Indica una palabra clave de C# o un tipo de .Net.
Negrita
Texto con énfasis adicional que debe ser considerado importante.
Términos claves
Descripción
Siempre...