Documento de Estandares de Programacion


Tabla de Contenidos
1. OBJETIVO 3
2. DECLARACION DE VARIABLES 4
2.1 Descripción de la Variable. 4
2.2 Variables de Tipo Arreglo 4
3. Definición de Controles 5
3.1 Prefijo para el Control 5
3.2 Nombre descriptivo del Control 5
3.3 Declaración de variables, atributos y objetos 5
3.4 Declaración de clases 6
3.5 Declaración de métodos 6
3.6 Declaración de funciones 7
3.7 Control de versionesde código fuente 7
4. Procedimientos y Funciones definidos por el Usuario. 8
5. Beneficios 9


Estándares de Programación


1. OBJETIVO

Reglamentar la forma en que se implementará el código fuente del proyecto, pasando, por las variable, controles, ficheros, archivos y todo aquello que esté implicado en el código,

Mejorar y uniformizar a través de las reglas que se proponen, el estilo deprogramación que tiene cada programador.

• Los nombres de variables serán mnemotécnicos con lo que se podrá saber el tipo de dato de cada variable con sólo ver el nombre de la variable.
• Los nombres de variables serán sugestivos, de tal forma que se podrá saber el uso y finalidad de dicha variable o función fácilmente con solo ver el nombre de la variable.
• La decisión de poner un nombre a unavariable o función será mecánica y automática, puesto que seguirá las reglas definidas por nuestro estándar.
• Permite el uso de herramientas automáticas de verificación de nomenclaturas.

Por tanto, se seguirán dichos patrones para un entendimiento legible del código y para facilitar el mantenimiento del mismo.
2. DECLARACION DE VARIABLES

Se propone que la declaración de las variables, seajusten al motivo para la que se requieran. El mnemotécnico definido se establece tomando en consideración principalmente lo siguiente:
La longitud debe ser lo más recomendable posible. No debe ser tan grande de tal forma que el programador tenga la facilidad de manejo sobre la variable y ni tan corta que no pueda describirse claramente. Para el caso establecemos una longitud máxima de variable de 15caracteres.

El tipo de dato al que pertenece la variable.

Por lo tanto la estructura de la variable es como sigue:

Estructura
Descripción de la Variable
LONGITUD. MAX.
 1  15 
FORMATO
Minúscula la primera parte y luego la segunda con Mayúsculas
EJEMPLO
numCuenta

Siendo el nombre que identifica a la variable: numCuenta

2.1 Descripción de la Variable.Nombre que se le asignara a la variable para que se le identifique y deberá de estar asociada al motivo para la cual se le declara.

Ejemplos: idCuenta, tipoEstado, instalacion

2.2 Variables de Tipo Arreglo
En el caso de las definiciones de arreglos de elementos se declarara la variable con el prefijo de “lista”, el cual nos dará entender que se trata de una variable del tipo arreglo la cualcontendrá de cero a mas datos, según el tamaño declarado.

Ejemplos: listaTiposDoc


3. Definición de Controles

Para poder determinar el nombre de un control dentro de cualquier aplicación de tipo visual, se procede a identificar el tipo al cual pertenece y la función que cumple dentro de la aplicación.


3.1 Prefijo para el Control
El prefijo del control será determinado mediante tres caracteres queestarán conformados por las consonantes más representativas del control, es así, por ejemplo; el control Button, estará asociado al prefijo btn.

3.2 Nombre descriptivo del Control
Formado por la descripción de la función que lleva a cabo el control, esta debe ser descrita en forma específica y clara.












3.3 Declaración de variables, atributos y objetos

1. Se debe declarar una variablepor línea.

Título
Descripción
Sintaxis
[TipoVariable] [Nombre de la Variable]
Descripción
Todas las variables tendrán una longitud máxima de 15 caracteres.
El nombre de la variable puede incluir más de un sustantivo los cuales se escribirán juntos.
Si se tuvieran variables que puedan tomar nombres iguales, se le agregará un número asociado (si está dentro de un mismo método será correlativo)....