Documento de Estndares de Programacin

Tabla de Contenidos
1. OBJETIVO.............................................................................................................................................4 2. DECLARACION DE VARIABLES.....................................................................................................5 2.1 Descripcin de la Varia le..........................................................................................................5 2.2 Varia les de Tip! Arre"l!...........................................................................................................5 #. De$inicin de C!n%r!les.........................................................................................................................& #.1 Tip! de da%!s...............................................................................................................................& #.2 're$i(! para el C!n%r!l.................................................................................................................& #.# N!) re descrip%i*! del C!n%r!l..................................................................................................& #.4 Declaracin de *aria les+ a%ri ,%!s - ! (e%!s............................................................................... #.5 Declaracin de clases................................................................................................................... #.& Declaracin de )/%!d!s............................................................................................................... #.. Declaracin de $,nci!nes............................................................................................................0 #.1 C!n%r!l de *ersi!nes de cdi"! $,en%e .......................................................................................0 4. 'r!cedi)ien%!s - 2,nci!nes de$inid!s p!r el 3s,ari!.........................................................................14 5. Bene$ici!s.............................................................................................................................................14 &. C!ncl,si!nes........................................................................................................................................14

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. !os nombres de variables sern mnemotcnicos con lo que se podr saber el tipo de dato de cada variable con slo ver el nombre de la variable. !os 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. !a decisin de poner un nombre a una variable o funcin ser mecnica y automtica, puesto que seguir las reglas definidas por nuestro estndar. "ermite el uso de herramientas automticas de verificacin de nomenclaturas. "or tanto, se seguirn dichos patrones para un entendimiento legible del cdigo y para facilitar el mantenimiento del mismo.

2.

DEC !"!CIO# DE V!"I!B E$

#e propone que la declaracin de las variables, se ajusten al motivo para la que se requieran. $l mnemotcnico definido se establece tomando en consideracin principalmente lo siguiente% !a longitud debe ser lo ms recomendable posible. &o 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. "ara el caso establecemos una longitud m'ima de variable de () caracteres. $l tipo de dato al que pertenece la variable.

"or lo tanto la estructura de la variable es como sigue% Estructura !*&+,-./. M01. 3*RM0-* $4$M"!* Descri%cin de la Variable ( (2

Minscula la primera parte y luego la segunda con Maysculas numCuenta

#iendo el nombre que identifica a la variable% numCuenta 2.1 Descri%cin de la Variable. &ombre 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. E&em%los' id5uenta, tipo$stado, instalacion 2.2 Variables de Ti%o !rreglo $n el caso de las definiciones de arreglos de elementos se declarara la variable con el prefijo de 6lista7, el cual nos dar entender que se trata de una variable del tipo arreglo la cual contendr de cero a mas datos, seg8n el tama9o declarado. E&em%los' lista-ipos/oc

(.

De)inicin de Controles

"ara 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. (.1 Ti%o de datos Ti%o de *ariable <yte ,nteger 5har #tring /ate <oolean 3loat /ouble *bject +nemnico by in ch st dt bl fl db ob Descri%cin $ntero de = bits sin signo. $ntero de >? bits con signo. .n carcter .&,5*/$ de () bits 5adena de caracteres 3ormato de fecha@hora Aalor lgico% verdadero y falso 5oma flotantes, ((B(? d:gitos significativos. 5oma flotante, )C bits D(2B() d:gitos significativosE *bjeto genrico

(.2 Pre)i&o %ara el Control $l prefijo del control ser determinado mediante tres caracteres que estarn conformados por las consonantes ms representativas del control, es as:, por ejemplo; el control <utton, estar asociado al prefijo btn. (.( #ombre descri%ti*o del Control 3ormado por la descripcin de la funcin que lleva a cabo el control, esta debe ser descrita en forma espec:fica y clara. Ti%o de control !abel -e't<o' <utton Radio<utton 5hecF<o' /rop/oGn!ist Pre)i&o lbl t't btn rdo chF cmb lbl&ombre t't0pellido btn!ogin rdo#eleccion chFRuta( cmb/ocumentos E&em%lo

(.,

Declaracin de *ariables- atributos . ob&etos (. #e debe declarar una variable por l:nea.

T/tulo
$inta0is Descri%cin

Descri%cin
H-ipoAariableI H&ombre de la AariableI -odas las variables o atributo tendrn una longitud m'ima de >J caracteres. $l nombre de la variable puede incluir ms de un sustantivo los cuales se escribirn juntos. #i se tuvieran variables que puedan tomar nombres iguales, se le agregar un n8mero asociado Dsi est dentro de un mismo mtodo ser correlativoE. $n la declaracin de variables o atributos no se deber utilizar caracteres como% !etra K o 9. 5aracteres especiales L, M, N, O, P, Q, @, D, E, R, S, T, B, U, V, W, H, I. 5aracteres tildados% , , :, , 8. "ublic #tring nombre ,ndica una variable o atributo que guardar un nombre.

Obser*aciones

E&em%lo

(.1

Declaracin de clases

T/tulo
$inta0is Descri%cin

Descri%cin
H-ipoI 5lass H&ombre de 5laseI $l nombre de las clases tendr una longitud m'ima de >J caracteres y las primeras letras de todas las palabras estarn en may8sculas. -ipo se refiere a si la clase ser% "rivate, "ublic o "rotected. $n la declaracin de clases no se deber utilizar caracteres como% !etra K o 9. 5aracteres especiales L, M, N, O, P, Q, @, D, E, R, S, T, B, U, V, W, H, I. 5aracteres tildados% , , :, , 8. "rivate 5lass $mpleado ,ndica una clase $mpleado

Obser*aciones

E&em%lo

(.2

Declaracin de m3todos

T/tulo
$inta0is Descri%cin

Descri%cin
nombre"rocedimHD!ista"armetrosEI $l nombre del mtodo constar hasta de ?2 caracteres. !a primera letra de la primera palabra del nombre ser escrita en

Obser*aciones

E&em%lo

min8scula y las siguientes palabras empezarn con letra may8scula. $n la declaracin de mtodos no se deber utilizar caracteres como% !etra K o 9. 5aracteres especiales L, M, N, O, P, Q, @, D, E, R, S, T, B, U, V, W, H, I, X. 5aracteres tildados% , , :, , 8. "rotected calcular#ueldoD#tring empleadoE ,ndica un mtodo calcular#ueldo que recibe una variable por valor de tipo string al mbito de la clase

(.4

Declaracin de )unciones

T/tulo
$inta0is Descri%cin

Descri%cin
H-ipo/atoI nombre3uncionHD!ista"armetrosEI $l nombre del objeto constar hasta de ?2 caracteres, no es necesario colocar un nombre que indique la clase a la cual pertenece. !a primera letra de la primera palabra del nombre ser escrita en may8sculas $l tipo de dato de retorno se coloca al final y ser obligatorio colocarlo. $n la declaracin de objetos no se deber utilizar caracteres como% !etra K o 9. 5aracteres especiales L, M, N, O, P, Q, @, D, E, R, S, T, B, U, V, W, H, I, X. 5aracteres tildados% , , :, , 8. "ublic int sumarDint 0, int <E ,ndica una funcin que suma dos variables enteras

Obser*aciones

E&em%lo

(.5 Control de *ersiones de cdigo )uente 5ada modificacin realizada ser guardada de la forma%

T/tulo
6ormato Descri%cin

Descri%cin
H&*M<R$ /*5.M$&-*IH X IH3$5Y0IH X IHY*R0I donde y la fecha estar en formato yyyymmdd y la hora en formato YYMM. #e generarn archivos con las siguientes e'tensiones%.zip o .rar. "or ejemplo% Z#-$&&,#X?JJ[JC?(X?J2).zip

,.

Procedimientos . 6unciones de)inidos %or el 7suario.

$l 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 $l estndar para nombres de procedimiento es usar un Aerbo que describa la accin realizada seguida por un sustantivo Dobjeto sobre el cual act8aE. #e recomienda% .sar un nombre que represente una accin y un objeto. $l nombre del procedimiento debe indicar qu hace el procedimiento a... o qu hace el procedimiento con.... $l verbo debe estar en infinitivo. #er consistente en el orden de las palabras. #i se va a usar verboNombre, siempre usar verboNombre. #er consistente en los verbos y sustantivos usados. "or ejemplo si tiene un procedimiento asignarNombre, tambin usar asignarApellido en vez de colocarApellido. "ara la accin modi)icar cuentas del cliente se define% modificar 5uenta Aerbo% modificar #ustantivo% 5uenta

#ota' &o se har uso de los caracteres% $spacio en blanco \ \, 5aracter de subrayado \X\. !a 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.

1.

Bene)icios
!a documentacin hace ms legible un programa. 0l 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. 3acilita la reutilizacin de mdulos y rutinas desde cualquier otro programa o el mismo. 0yuda a determinar cundo debe ser reescrito un cdigo. #i e'isten problemas para e'plicar el cdigo con un comentario, probablemente el cdigo est mal escrito.

2.

Conclusiones
.na buena programacin e implementacin legible, solo se logra usando y llevando de la mano un buen estndar o patrn de programacin. $s muy importante que el programador tenga un conocimiento previo del estndar o en su defecto que lea el documento para prever diferencias. 0l documentar se obtienen dos cosas fundamentales, un documento legible y segundo una buena base para los futuros desarrollos de mantenimiento del cdigo.