2 de febrero de 2004

Comentarios en nuestros programas

Agregue comentarios en sus programas para aumentar la legibilidad del código.

Una buena práctica de programación es comentar el código de nuestros programas. Esto nos ayudará a una mejor comprensión de código escrito en el pasado y mas aun si el código es compartido por un equipo de desarrollo de varias personas.

En Visual FoxPro existen varias formas de comentar nuestro código.

Quizás la forma mas conocida es iniciar una línea con el caracter " * " (asterisco) que nos indica el comienzo de una línea de comentarios no ejecutable en nuestro archivo de programa.

Ejemplo:
* Esto es un comentario de nuestro código
Otra forma similar es utilizar el comando " NOTE ", que también nos indica el comienzo de una línea de comentarios no ejecutable en nuestro código.

Ejemplo:
NOTE Esto es una línea de comentario
Otro comando que podemos utilizar para nuestros comentarios es " && "que indica que a continuación aparece un comentario en línea.

Ejemplo:
lnMes = 1
DO WHILE lnMes <= 12 && Ciclo de 12 meses
  lnMes = lnMes + 1
ENDDO && WHILE lnMes <= 12
La inserción de comentarios en línea para indicar el final de los comandos de programación estructurados IF ... ENDIF, DO WHILE ... ENDDO, CASE ... ENDCASE y FOR ... ENDFOR mejora significativamente la legibilidad del código.

Todas estas formas admiten el " ; " (punto y coma) al final de la línea de comentarios, que indica que el comentario continua en la linea siguiente

Ejemplo:
* Esto es un comentario que abarca ;
  dos líneas

NOTE Esto es una línea de comentarios que ;
  continua en la siguiente línea

IF DAY(DATE()) = 1 && Si es el primer día del ;
  mes se ejecuta el siguiente código
  ? "Primer día del mes"
ENDIF && DAY(DATE()) = 1
Otra buena práctica de programación es colocar texto al inicio de nuestros programas o funciones con datos como: nombre, autor, fecha, descripción, etc.

A partir de VFP8 tenemos la Caja de Herramientas (Toolbox) que nos permite tener plantillas de trozos de textos (text scrap) para añadir a nuestros programas con solo arrastrar y soltar (drag & drop). Por ejemplo podemos tener el siguiente trozo de texto en el Toolbox para comenzar nuestros procemientos o funciones:

*---------------------
* PROCEDURE / FUNCTION
*---------------------
* Autor......:
* Fecha......: <<DATE()>>
* Descripción:
* Uso........:
* Parámetros.:
* Retorno....:
*---------------------
Con solo arrastrar y soltar el trozo de texto desde el Toolbox a nuestro archivo de programa, este aparecerá escrito. En el trozo de texto podemos tener texto de funciones o expresiones rodeados por delimitadores de combinación de texto (Ej: <<DATE()>>) que se evaluarán si en las propiedades del trozo de texto (text scrap) marcamos la casilla de verificación "Evaluar usando text merge".

Luis María Guayán

1 comentario :