Convenciones de notación

Las convenciones de notación consisten en una serie de normas no oficiales a la hora de declarar elementos en el código, que facilitan su interpretación y mantenimiento.

Si bien esto no es inicialmente necesario, ni la herramienta de programación obliga a ello, en la práctica se ha demostrado que una serie de normas a la hora de escribir el código redundan en una mayor velocidad de desarrollo y facilidad de mantenimiento de la aplicación. Siendo útil no sólo en grupos de trabajo, sino también para programadores independientes.

Seguidamente describiremos una serie de normas de codificación para variables y constantes, que no son en absoluto obligatorias a la hora de escribir el código del programa, pero si pretenden concienciar al lector de la necesidad de seguir unas pautas comunes a la hora de escribir dicho código, de manera que al compartirlo entre programadores, o cuando tengamos que revisar una aplicación desarrollada tiempo atrás, empleemos el menor tiempo posible en descifrar lo que tal o cual variable significa en el contexto de una rutina o módulo.

• Variables. El formato utilizado para la notación de variables se basa en utilizar un carácter para indicar el ámbito de la variable, seguido de uno o dos caracteres para especificar el tipo

de dato y el resto del nombre que daremos a la variable o cuerpo. Ver el Código fuente 177.

<Ámbito><TipoDato><Cuerpo>

Código fuente 177

Programación con Visual Basic .NET © Grupo EIDOS

La Tabla 21 muestra los valores para ámbito.

Ámbito que define Carácter

l Local m Módulo (privado) p Proyecto (público)

Tabla 21. Caracteres para indicar el ámbito en los nombres de variables.

La Tabla 22 muestra los valores para el tipo de dato.

Tipo de dato que define Carácter

b Boolean by Byte

c Char dt Date

dc Decimal

db Double

i Integer l Long sh Short sg Single

o Object s String

Tabla 22. Caracteres para indicar el tipo de dato en los nombres de las variables.

Para el cuerpo de la variable se utilizará WordMixing, que consiste en una técnica en la cuál empleamos, si es necesario, varias palabras juntas para describir mejor el contenido de la variable. Veamos unos ejemplos en el Código fuente 178.

' variable local de tipo integer liCodAcceso

' variable a nivel de módulo de tipo string msNombreUsuario

' variable a nivel de proyecto de tipo fecha pdtDiaAlta

Código fuente 178

En el caso de objetos creados por el programador, utilizaremos como prefijo para el tipo de dato, el carácter “o”, o bien tres caracteres indicativos de la clase. Ver el Código fuente 179.

' variable local cuyo tipo es un objeto creado por el programador Dim loEmpleado As Empleado Dim lempEmpleado As Empleado

Código fuente 179

• Constantes. En este caso seguiremos el mismo formato de notación que para las variables en lo que respecta al ámbito y tipo de dato. El cuerpo de la constante sin embargo, deberemos

escribirlo en mayúsculas, y separar las distintas palabras utilizando el carácter de guión bajo ( _ ) en vez de WordMixing. Código fuente 180.

' constante a nivel de proyecto de tipo integer piTIPO_IVA

' constante a nivel de módulo de tipo string msCOLOR_INICIAL

Código fuente 180

Convenciones de notación