Documento de Estándares de Programación





Documento de Estándares de Programación





Versión 1.0




Elaborado por:
Marco Miranda
F. Elaboración:
15/01/2010
Modificado por:
Carlos Romero
F. Ultima Modificación:
20/01/2010
Aprobado por:
Sandra Mendoza
F. Aprobación:
21/01/2010
HISTORIAL DE VERSIONES

Versión:
1.0

Realizado por:
Marco Miranda
Fecha modificación:
15/01/2010
Descripción:
Definelos estándares de nomenclatura para el modelo físico de datos.
Aprobado por:
Sandra Mendoza
Fecha aprobación :
21/01/2010


ÍNDICE

CAPÍTULO 1. Estándares de Programación 5
1.1.Objetivos 5
1.2.Alcance 5
1.3.Convenciones del documento 5
1.4.Términos y definiciones 6
1.5.Estilo de Codificación 6
1.6.Uso del Lenguaje 6
1.7.Recomendaciones generales de nombramiento 7
1.8.Uso de Nombresy Sintaxis 8
1.9.Formato Codificación 11

CAPÍTULO 1. Estándares de Programación
1.1. Objetivos
Este documento tiene como objetivo enunciar y explicar las reglas y recomendaciones que deben seguirse al desarrollar el módulo de Compras y Almacén. Esto permitirá que el proyecto se enmarque en un estilo y formato único que prevenga la ocurrencia de errores comunes.
Como parte del contenido, seha incluido las convenciones de nombres, estilos de codificación, para el uso del lenguaje Visual Basic .NET así como mejores prácticas para la construcción de las aplicaciones.
1.2. Alcance
Todos los módulos en los que se ha dividido el proyecto trabajarán de acuerdo a los estándares establecidos en este documento, para de esta manera poder integrarlos fácilmente y de manera correcta. Caberesaltar que en el producto final, algunos elementos pueden variar, más no las convenciones para nombres y tamaños además las imágenes mostradas son referenciales y no reflejan el producto final.
1.3. Convenciones del documento
Para asegurar el fácil entendimiento del presente documento se recomienda tomar en cuenta las siguientes convenciones y reglas.
Color y Énfasis
Azul: El texto coloreadode azul indica que se trata de una palabra reservada es decir que pertenece al leguaje de programación Visual Basic .NET.
Negrita: Texto con énfasis adicional para resaltarlo.

Palabras Clave:
Siempre: Enfatiza que la regla se debe cumplir.
Nunca: Enfatiza que la acción nunca se debe de ejecutar.
Evitar: Enfatiza que la acción debe de ser prevenida, pero algunas excepciones pueden existir.Tratar: Enfatiza que la regla debe de cumplirse siempre y cuando sea posible y sea adecuado.
Ejemplo: Precede el texto usado para ilustrar la regla o recomendación.
Razón: Explica el propósito detrás de la regla o recomendación.


1.4. Términos y definiciones
La siguiente terminología es referenciada a través de este documento:
Modificador de Acceso:
Las palabras clave de VB.NET quedeclaran el nivel de accesibilidad de código que se tiene para tipos y miembros.
Ejemplo:
Private, Public, Friend, Protected, Shared

Aunque los modificadores de acceso varían, las clases y la mayoría de sus miembros en VB. Net son declarados como PUBLIC por defecto.

Camel Case:
Forma de escribir una palabra donde su primera letra esta en minúsculas, y la primera letra de las subsiguientespalabras en mayúsculas.
Ejemplo:
nombreVendedor

Pascal Case:
Forma de escribir una palabra donde la primera letra esta en mayúscula, y la primera letra de las subsiguientes palabras igualmente en mayúscula.
Ejemplo:
NombreVendedor


1.5. Estilo de Codificación
Código
Estilo
Archivo Fuente
Un espacio de nombre por archivo y una clase por archivo.
Indentación
Usar tabs de tamaño de 4espacios en blanco.
Comentarios
Usar el ‘ para todo tipo de comentario.
Variables
Una variable por declaración



1.6. Uso del Lenguaje
Código
Estilo
Tipos Nativos de Datos
Usar datos nativos de datos de VB.NET versus los tipos del CTS del .NET.
Usar Integer NO System.Int32
Propiedades
Evitar utilizar prefijos Get o Set
MyBase / base
Usar solamente en constructores o en...