Estándares codificación c#

Estándares Codificación C#
1. Introducción
1.1 Propósito
Este documento describe todas las convenciones, estándares y formatos que se utilizaran
para la creación de código en C#. Este documento esta basado en las Especificaciones del
Lenguaje C# producidas por ECMA TC39/TG2. El propósito de establecer estándares de
codificación es mejorar la productividad y la calidad.
1.2 Alcance
Estedocumento se ha basado en un conjunto de estándares, definidos para el lenguaje C#
y los utilizados por Microsoft para definir, formatos y lineamientos guía, en la generación de código
y nomenclatura para la codificación de programas en C#, así como para documentar el código
fuente.
1.3 Definiciones, acrónimos y abreviaturas
1.4 Referencias
C# Language Specification. Final Draft – October2002. Producido por ECMA TC39/TG2.
(REF: C# Standard.doc)
2. Guía de Organización y Nomenclatura para los Assemblies.
Los paquetes o assemblies deben contener solo letras, y no deberán contener acentos.
Ejemplo:
System.IO;
System.Runtime;
ME.ConvBS;
Los nombres de los assemblies deberán estar formados de la siguiente forma:
.
Donde:
servirá para identificar que el assembly fue creado parala
empresa.
es el nombre clave del proyecto o módulo que se está
programando
es la abreviación a dos letras de la capa a la que pertenece el assembly
Ejemplo:
Para un assembly de un proyecto para MiEmpresa, con nombre clave o abreviación del nombre
“CONV”, de la capa nombrada “Bussines Services”, el nombre sería:
ME.ConvBS

En los casos en que el contenido del assembly sea genérico(que contenga funcionalidad
que puede ser utilizada en otros proyectos), en el nombre del assembly se omitirá .
Ejemplo:
Para un assembly que contiene la implementación de métodos de conversión de fechas
que pueden ser de utilidad para dos o más proyectos, el nombre del assembly podría ser el
siguiente:
ME.ManejoFechas
Los nombres de estos assemblies deberán ser auditados por el líder deproyecto.
3. Guía de Organización y Nomenclatura para los Namespaces
Los namespaces deben contener solo letras, y no deberán contener acentos.
Ejemplo:
System.IO;
System.Runtime;
ME.FacturacionDA;
Los nombres de los namespaces deberán estar formados de la siguiente forma:
.[.][NombreDescriptivo]
Donde:
servirá para identificar que el namspace pertenece a la empresa.
es el nombredescriptivo particular que se le dará a cada
namespace
es la abreviación a dos letras de la capa a la que pertenece el
namespace
[.][NombreDescriptivo] es opcional y es en el caso de que se desee generar un
namspace dentro de otro. (No hay restricción para el anidamiento de namespaces)
Ejemplo:
El nombre de un namspace del proyecto con nombre clave “CONV”, de la capa nombrada
“User Services”, quecontiene la implementación necesaria para el proceso de facturación, el
nombre sería:
ME.FacturacionUS
No hay ninguna restricción para generar una mayor jerarquía dentro de los namespaces con el objeto
de estructurar mejor el código. Siempre que sea necesario, se deberá hacer crecer la jerarquía de los
namspaces para una mejor estructura del código.
Ejemplo:
En un assembly que contiene laimplementación de toda la capa “User Services” de un
proyeco cuyo nombre clave es “CONV”, y que contiene la interfaz gráfica de un módulo para
“Facturación” y otro módulo para “Crédito”, su estructura sería la siguiente:
Nombre del Assembly: ME.ConvUS

Nombre del Namspace para el módulo de Facturacion: ME.FacturacionUS
Nombre del Namspace para el módulo de Facturacion: ME.CreditoUS
En loscasos en que el contenido del namespace sea genérico (que contenga funcionalidad
que puede ser utilizada en otros proyectos), el nombre del namespace deberá ser de la siguiente
forma:
ME.FrameWork.
Donde:
ME servirá para identificar que el namspace pertenece a ME.
FrameWork servirá para identificar que el namespace contiene funciones generales
es el nombre descriptivo particular que se le...