UNIVERSIDAD NACIONAL EXPERIMENTAL POLITCNICA DE LA FUERZA ARMADA BOLIVARIANA CARRERA: INGENIERA DE SISTEMAS. ASIGNATURA: PROGRAMACIN III.

CONVENCIONES DE CODIFICACIN EN VISUAL BASIC

Las Convenciones de Codificacin Las convenciones de codificacin son pautas de programacin que no estn enfocadas a la lgica del programa, sino a su estructura y apariencia fsica. Facilitan la lectura, comprensin y mantenimiento del cdigo. Las convenciones de codificacin pueden incluir: Convenciones de nombres para objetos, variables y procedimientos. Formatos estandarizados para etiquetar y comentar el cdigo. Instrucciones de espaciado, formato y sangra. En las secciones siguientes se explica cada una de estas reas y se dan ejemplos de su uso correcto.

Por qu existen las convenciones de codificacin? La razn principal de usar un conjunto coherente de convenciones de cdigo es estandarizar la estructura y el estilo de codificacin de una aplicacin de forma que el autor y otras personas puedan leer y entender el cdigo fcilmente. Las convenciones de codificacin correctas dan como resultado un cdigo fuente preciso, legible y sin ambigedad, que es coherente con otras convenciones del lenguaje y lo ms intuitivo posible.

Convenciones de codificacin mnimas Un conjunto de convenciones de codificacin de propsito general debe definir los requisitos mnimos necesarios para conseguir los objetivos explicados anteriormente, dejando libertad al programador para crear la lgica y el flujo funcional del programa.

El objetivo es hacer que el programa sea fcil de leer y de entender sin obstruir la creatividad natural del programador con imposiciones excesivas y restricciones arbitrarias. Por tanto, las convenciones sugeridas en esta gua son breves y sugerentes. No muestran todos los objetos y controles posibles, ni especifican todos los tipos de comentarios informativos que podran ser tiles. Dependiendo del proyecto y de las necesidades especficas de la organizacin, quizs desee ampliar estas instrucciones para que incluyan elementos adicionales como: Convenciones para objetos especficos y componentes desarrollados internamente o comprados a otros proveedores. Variables que describan las actividades comerciales o instalaciones de la organizacin. Cualquier otro elemento que el proyecto o la empresa considere importante para conseguir mayor claridad y legibilidad.

Convenciones de nombres de constantes y variables Adems de los objetos, las constantes y variables tambin requieren convenciones de nombres bien compuestas. En esta seccin se muestran las convenciones recomendadas para las constantes y variables permitidas por Visual Basic. Tambin se explican cuestiones relacionadas con la identificacin del tipo de datos y su alcance. Las variables se deben definir siempre con el menor alcance posible. Las variables globales (pblicas) pueden crear mquinas de estado enormemente complejas y hacer la lgica de una aplicacin muy difcil de entender. Las variables globales tambin hacen mucho ms difcil mantener y volver a usar el cdigo.

En Visual Basic las variables pueden tener el alcance siguiente:

Convenciones de Codificacin en Visual Basic En una aplicacin de Visual Basic, las variables globales se deben usar slo cuando no exista ninguna otra forma cmoda de compartir datos entre formularios. Cuando haya que usar variables globales, es conveniente declararlas todas en un nico mdulo agrupadas por funciones y dar al mdulo un nombre significativo que indique su finalidad, como Public.bas. Una prctica de codificacin correcta es escribir cdigo modular siempre que sea posible. Por ejemplo, si la aplicacin muestra un cuadro de dilogo, coloque todos los controles y el cdigo necesario para ejecutar la tarea del dilogo en un nico formulario. Esto ayuda a tener el cdigo de la aplicacin organizado en componentes tiles y minimiza la sobrecarga en tiempo de ejecucin. A excepcin de las variables globales (que no se deberan pasar), los procedimientos y funciones deben operar slo sobre los objetos que se les pasan. Las variables globales que se usan en los procedimientos deben estar identificadas en la seccin Declaraciones al principio del procedimiento. Adems, los argumentos se deben pasar a los procedimientos Sub y Function mediante ByVal, a menos que sea necesario explcitamente cambiar el valor del argumento que se pasa.

Prefijos de alcance de variables A medida que aumenta el tamao del proyecto, tambin aumenta la utilidad de reconocer rpidamente el alcance de las variables. Esto se consigue escribiendo un prefijo de alcance de una letra delante del tipo de prefijo, sin aumentar demasiado la longitud del nombre de las variables.

Una variable tiene alcance global si se declara como Public en un mdulo estndar o en un mdulo de formulario. Una variable tiene alcance de nivel de mdulo si se declara como Private en un mdulo estndar o en un mdulo de formulario, respectivamente.

Nota: La coherencia es crucial para usar esta tcnica de forma productiva; el corrector de sintaxis de Visual Basic no interceptar las variables de nivel de mdulo que comiencen con "p". Constantes El cuerpo del nombre de las constantes se debe escribir en maysculas y minsculas, con la letra inicial de cada palabra en maysculas. Aunque las constantes estndar de Visual Basic no incluyen informacin de tipo de datos y el alcance, los prefijos como i, s, g y m pueden ser muy tiles para entender el valor y el alcance de una constante. Para los nombres de constantes, se deben seguir las mismas normas que para las variables. Por ejemplo: mintMxListaUsuario ' Lmite de entradas mximas para ' la lista de usuarios (valor ' entero, local del mdulo) gstrNuevaLnea ' Carcter de nueva lnea '(cadena, global de la ' aplicacin)

Variables Declarar todas las variables ahorra tiempo de programacin porque reduce el nmero de errores debidos a erratas (por ejemplo, aNombreUsuarioTmp frente a sNombreUsuarioTmp frente a sNombreUsuarioTemp). En la ficha Editor del cuadro de dilogo Opciones, active la opcin Declaracin de variables requerida. La instruccin Option Explicit requiere que declare todas las variables del programa de Visual Basic. Las variables deben llevar un prefijo para indicar su tipo de datos. Opcionalmente, y en especial para programas largos, el prefijo se puede ampliar para indicar el alcance de la variable.

Tipos de datos de variables Use los prefijos siguientes para indicar el tipo de datos de una variable.

Nombres descriptivos de variables y procedimientos El cuerpo de un nombre de variable o procedimiento se debe escribir en maysculas y minsculas y debe tener la longitud necesaria para describir su funcionalidad. Adems, los nombres de funciones deben empezar con un verbo, como IniciarNombreMatriz o CerrarDilogo. Para nombres que se usen con frecuencia o para trminos largos, se recomienda usar abreviaturas estndar para que los nombres tengan una longitud razonable. En general, los nombres de variables con ms de 32 caracteres pueden ser difciles de leer en pantallas VGA. Cuando se usen abreviaturas, hay que asegurarse de que sean coherentes en toda la aplicacin. Alternar aleatoriamente entre Cnt y Contar dentro de un proyecto provoca una confusin innecesaria.

Tipos definidos por el usuario En un proyecto grande con muchos tipos definidos por el usuario, suele ser til dar a cada uno de estos tipos un prefijo de tres caracteres slo suyo. Si estos prefijos comienzan con "u", ser fcil reconocerlos cuando se est trabajando con tipos definidos por el usuario. Por ejemplo, "ucli" se podra usar como prefijo para las variables de un tipo Cliente definido por el usuario.

Convenciones de codificacin estructurada Adems de las convenciones de nombres, las convenciones de codificacin estructurada, como comentarios al cdigo y sangras coherentes, pueden mejorar mucho la legibilidad del cdigo.

Convenciones de comentarios al cdigo Todos los procedimientos y funciones deben comenzar con un comentario breve que describa las caractersticas funcionales del procedimiento (qu hace). Esta descripcin no debe describir los detalles de implementacin (cmo lo hace), porque a veces cambian con el tiempo, dando como resultado un trabajo innecesario de mantenimiento de los comentarios o, lo que es peor, comentarios errneos. El propio cdigo y los comentarios de lneas necesarios describirn la implementacin. Los argumentos que se pasan a un procedimiento se deben describir cuando sus funciones no sean obvias y cuando el procedimiento espera que los argumentos estn en un intervalo especfico. Tambin hay que describir, al principio de cada procedimiento, los valores devueltos de funciones y las variables globales que modifica el procedimiento, en especial los modificados a travs de argumentos de referencia. Los bloques del comentario de encabezado del procedimiento deben incluir los siguientes encabezados de seccin. En la seccin siguiente, "Dar formato al cdigo", hay algunos ejemplos.

Recuerde los puntos siguientes: Cada declaracin de variable importante debe incluir un comentario de lnea que describa el uso de la variable que se est declarando. Las variables, controles y procedimientos deben tener un nombre bastante claro para que los comentarios de lnea slo sean necesarios en los detalles de implementacin complejos.

Al principio del mdulo .bas que contiene las declaraciones de constantes genricas de Visual Basic del proyecto, debe incluir un resumen que describa la aplicacin, enumerando los principales objetos de datos, procedimientos, algoritmos, cuadros de dilogo, bases de datos y dependencias del sistema. Algunas veces puede ser til un pseudocdigo que describa el algoritmo.

Dar formato al cdigo Como muchos programadores usan todava pantallas VGA, hay que ajustarse al espacio de la pantalla en la medida de lo posible y hacer que el formato del cdigo siga reflejando la estructura lgica y el anidamiento. Estos son algunos indicadores: Los bloques anidados estndar, separados por tabuladores, deben llevar una sangra de cuatro espacios (predeterminado). El comentario del esquema funcional de un procedimiento debe llevar una sangra de un espacio. Las instrucciones de nivel superior que siguen al comentario del esquema deben llevar una sangra de un tabulador, con cada bloque anidado separado por una sangra de un tabulador adicional. Por ejemplo:

'***************************************************** ' Finalidad: Ubica el primer caso encontrado de un ' usuario especificado en la matriz ListaUsuario. ' Entradas: ' ' strListaUsuario(): lista de usuarios para buscar. strUsuarioDest: nombre del usuario buscado.

' Resultados: ndice del primer caso de rsUsuarioDest ' encontrado en la matriz rasListaUsuario. ' Si no se encuentra el usuario de destino, ' devuelve -1. '*****************************************************

Function intFindUser (strUserList() As String, strTargetUsuer As _ String)As Integer Dim i As Integer ' Contador de bucle. Dim blnFound As Integer ' Indicador de ' destino encontrado. intFindUser = -1 i=0 While i <= Ubound(strUserList) and Not blnFound If strUserList(i) = strTargetUser Then blnFound = True intFindUser = i End If Wend End Function

Agrupacin de constantes Las variables y constantes definidas se deben agrupar por funciones en lugar de dividirlas en reas aisladas o archivos especiales. Las constantes genricas de Visual Basic se deben agrupar en un nico mdulo para separarlas de las declaraciones especficas de la aplicacin.

Operadores & y + Use siempre el operador & para unir cadenas y el operador + cuando trabaje con valores numricos. El uso del operador + para concatenar puede causar problemas cuando se opera sobre dos variables Variant. Por ejemplo: vntVar1 = "10,01" vntVar2 = 11 vntResult = vntVar1 + vntVar2 'vntResult = 21,01 vntResult = vntVar1 & vntVar2 'vntResult = 10,0111

Crear cadenas para MsgBox, InputBox y consultas SQL Cuando est creando una cadena larga, use el carcter de subrayado de continuacin de lnea para crear mltiples lneas de cdigo, de forma que pueda leer o depurar la cadena fcilmente. Esta tcnica es especialmente til cuando se muestra un 8

cuadro de mensaje (MsgBox) o un cuadro de entrada (InputBox), o cuando se crea una cadena SQL. Por ejemplo:

Dim Msg As String Msg = "Esto es un prrafo que estar en un" _ & " cuadro de mensajes. El texto est separado en" _ & " varias lneas de cdigo en el cdigo fuente, " _ & "lo que facilita al programador la tarea de leer y depurar." MsgBox Msg

Dim CTA As String CTA = "SELECT *" _ & " FROM Ttulo" _ & " WHERE [Fecha de publicacin] > 1988" ConsultaTtulos.SQL = CTA