Documento de Estndares de Programacin

Portal web de la Municipalidad Provincial de

Santiago de Chuco
Versin 1.2

INDICE
1.

OBJETIVO

2.

DECLARACION DE VARIABLES
2.1 Descripcin de la Variable.
2.2 Variables de Tipo Arreglo

3.

Definicin de Controles
3.1 Tipo de datos
3.2 Prefijo para el Control
3.3 Nombre descriptivo del Control
3.4 Declaracin de variables, atributos y objetos
3.5 Declaracin de clases
3.6 Declaracin de mtodos
3.7 Declaracin de funciones
3.8 Control de versiones de cdigo fuente

4.

Procedimientos y Funciones definidos por el Usuario.

5.

Beneficios

6.

Conclusiones

ESTNDARES DE PROGRAMACIN

1.

OBJETIVO
Reglamentar la forma en que se implementar el cdigo fuente del proyecto, pasando,
por las variable, controles, ficheros, archivos y todo aquello que est implicado en el
cdigo,
Mejorar y uniformizar a travs de las reglas que se proponen, el estilo de
programacin que tiene cada programador.

Los nombres de variables sern nemotcnicos con lo que se podr saber el tipo
de dato de cada variable con slo ver el nombre de la variable.
Los nombres de variables sern sugestivos, de tal forma que se podr saber el
uso y finalidad de dicha variable o funcin fcilmente con solo ver el nombre
de la variable.
La decisin de poner un nombre a una variable o funcin ser mecnica y
automtica, puesto que seguir las reglas definidas por nuestro estndar.
Permite el uso de herramientas automticas de verificacin de nomenclaturas.

Por tanto, se seguirn dichos patrones para un entendimiento legible del cdigo y para
facilitar el mantenimiento del mismo.

2.

DECLARACION DE VARIABLES
Se propone que la declaracin de las variables, se ajusten al motivo para la que se
requieran. El nemotcnico definido se establece tomando en consideracin
principalmente lo siguiente:

La longitud debe ser lo ms 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 mxima de variable de 25 caracteres.

El tipo de dato al que pertenece la variable.

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

Estructura
Descripcin de la Variable
25
LONGITUD. MAX. 1
FORMATO
EJEMPLO

Minscula la primera parte y luego la

segunda con Maysculas
tipo_galeria

Siendo el nombre que identifica a la variable: tipo_galeria

2.1

Descripcin 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: id_galeria, galeria

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 cual contendr de cero a mas datos, segn el tamao declarado.
Ejemplos: lista_tipo_galeria

3.

Definicin de Controles
Para poder determinar el nombre de un control dentro de cualquier aplicacin de tipo
visual, se procede a identificar el tipo al cual pertenece y la funcin que cumple dentro
de la aplicacin.

3.1

Tipo de datos
Tipo de
variable
Byte
Integer
Char
String
Date
Boolean
Float
Double
Object

Mnemnico
by
in
ch
st
dt
bl
fl
db
ob

Descripcin
Entero de 8 bits sin signo.
Entero de 32 bits con signo.
Un carcter UNICODE de 16 bits
Cadena de caracteres
Formato de fecha/hora
Valor lgico: verdadero y falso
Coma flotantes, 11-12 dgitos significativos.
Coma flotante, 64 bits (15-16 dgitos significativos)
Objeto genrico

3.2

Prefijo para el Control

El prefijo del control ser determinado mediante tres caracteres que estarn
conformados por las consonantes ms representativas del control, es as, por ejemplo;
el control Button, estar asociado al prefijo btn.

3.3

Nombre descriptivo del Control

Formado por la descripcin de la funcin que lleva a cabo el control, esta debe ser
descrita en forma especfica y clara.
Tipo de

Prefijo

control
Label
TextBox
Button
RadioButton
CheckBox
DropDownList

lbl
txt
btn
rdo
chk
cmb

Ejemplo
lbl_nombre
txt_apellido
btn_login
rbn_seleccion
chk_ruta1
cmb_documentos

3.4

Declaracin de variables, atributos y objetos

1. Se debe declarar una variable por lnea.
Ttulo
Sintaxis
Descripcin

Observaciones

Ejemplo

3.5

Descripcin
[Nombre de la Variable]
Todas las variables o atributo tendrn una longitud mxima de
30 caracteres.
El nombre de la variable puede incluir ms de un sustantivo
los cuales se escribirn juntos.
Si se tuvieran variables que puedan tomar nombres iguales, se
le agregar un nmero asociado (si est dentro de un mismo
mtodo ser correlativo).
En la declaracin de variables o atributos no se deber utilizar
caracteres como:
Letra o .
Caracteres especiales , ^, #, $, %, &, /, (, ), , , +, -,
*, {, }, [, ].
Caracteres tildados: , , , , .
$nombre
Indica una variable o atributo que guardar un nombre.

Declaracin de clases
Ttulo
Sintaxis
Descripcin

Observaciones

Ejemplo

Descripcin
Class [Nombre de Clase]
El nombre de las clases tendr una longitud mxima de 30
caracteres y las primeras letras de todas las palabras estarn
en maysculas. Tipo se refiere a si la clase ser: Private,
Public o Protected.
En la declaracin de clases no se deber utilizar caracteres
como:
Letra o .
Caracteres especiales , ^, #, $, %, &, /, (, ), , , +, -,
*, {, }, [, ].
Caracteres tildados: , , , , .
Class Galeria
Indica una clase Galeria

3.6

Declaracin de mtodos
Ttulo
Sintaxis
Descripcin
Observaciones

Ejemplo

3.7

Declaracin de funciones
Ttulo
Sintaxis
Descripcin

Observaciones

Ejemplo

3.8

Descripcin
nombre_metodo[(ListaParmetros)]
El nombre del mtodo constar hasta de 25 caracteres.
La primera letra de la primera palabra del nombre ser escrita en
minscula y las siguientes palabras empezarn con letra minscula.
En la declaracin de mtodos no se deber utilizar caracteres como:
Letra o .
Caracteres especiales , ^, #, $, %, &, /, (, ), , , +, -, *, {, },
[, ], _.
Caracteres tildados: , , , , .
Public function calcular_sueldo($empleado)
Indica un mtodo calcular_sueldo que recibe una variable al mbito
de la clase

Descripcin
[TipoDato] nombreFuncion[(ListaParmetros)]
El nombre del objeto constar hasta de 25 caracteres, no es
necesario colocar un nombre que indique la clase a la cual
pertenece.
La primera letra de la primera palabra del nombre ser escrita en
maysculas
El tipo de dato de retorno se coloca al final y ser obligatorio
colocarlo.
En la declaracin de objetos no se deber utilizar caracteres como:
Letra o .
Caracteres especiales , ^, #, $, %, &, /, (, ), , , +, -, *, {, },
[, ], _.
Caracteres tildados: , , , , .
Public int sumar(int A, int B)
Indica una funcin que suma dos variables enteras

Control de versiones de cdigo fuente

Cada modificacin realizada ser guardada de la forma:
Ttulo
Formato
Descripcin

Descripcin
[NOMBRE DOCUMENTO][ _ ][FECHA][ _ ][HORA] donde y la
fecha estar en formato yyyymmdd y la hora en formato HHMM.
Se generarn archivos con las siguientes extensiones:.zip o .rar. Por
ejemplo:
MPSCH_20141221_2056.zip

4.

Procedimientos y Funciones definidos por el Usuario.

El nombre de las funciones y procedimientos debe ser auto descriptivo de manera que
no se requiera, en lo posible, entrar al cdigo de la funcin para saber qu es lo que
realiza.
verbo_sustantivo
El estndar para nombres de procedimiento es usar un Verbo que describa la accin
realizada seguida por un sustantivo (objeto sobre el cual acta). Se recomienda:
Usar un nombre que represente una accin y un objeto. El nombre del
procedimiento debe indicar qu hace el procedimiento a... o qu hace el
procedimiento con....
El verbo debe estar en infinitivo.
Ser consistente en el orden de las palabras. Si se va a usar verbo_nombre, siempre
usar verbo_nombre.
Ser consistente en los verbos y sustantivos usados. Por ejemplo si tiene un
procedimiento asignar_nombre, tambin usar asignar_apellido en vez de
colocar_apellido.
Para la accin modificar cuentas del cliente se define:
modificar_cuenta
Verbo: modificar
Sustantivo: cuenta
Nota:
No se har uso de los caracteres: Espacio en blanco " .
La nomenclatura de argumentos o parmetros pasados a los
procedimientos/funciones as como para valores devueltos por funciones sigue
las mismas convenciones que la nomenclatura para variables.

5.

Beneficios

La documentacin hace ms legible un programa.

Al documentar bien un programa desde un principio se evita que para cada
modificacin deba estudiarse profundamente el funcionamiento del programa,
redescubriendo todo lo no documentado, con la ventaja adicional de que
generalmente quin modifica el programa no es siempre quin lo escribi.
Facilita la reutilizacin de mdulos y rutinas desde cualquier otro programa o el
mismo.
Ayuda a determinar cundo debe ser reescrito un cdigo. Si existen problemas para
explicar el cdigo con un comentario, probablemente el cdigo est mal escrito.

6.

Conclusiones

Una buena programacin e implementacin legible, solo se logra usando y

llevando de la mano un buen estndar o patrn de programacin.
Es muy importante que el programador tenga un conocimiento previo del estndar
o en su defecto que lea el documento para prever diferencias.
Al documentar se obtienen dos cosas fundamentales, un documento legible y
segundo una buena base para los futuros desarrollos de mantenimiento del cdigo.