Comentarios

Los comentarios son observaciones realizadas por el programador dentro de los programas y que no se ejecutará por el compilador del lenguaje. Éstas sirven para documentar el objetivo del programa y algunos pasajes, como cálculos y fórmulas, que son importantes.

La inclusión de comentarios en los códigos de los programas es extremamente importante para dejarlos más claros, fáciles de comprenderse y consecuentemente, más fáciles de modificarse o corregirse. El AdvPL permite la inclusión de varios tipos de comentarios, como mostraremos a continuación y como también puede observarse en nuestro ejemplo de programa.

Varias líneas

Diversas líneas de comentarios pueden incluirse dentro del código de los programas, siempre y cuando se inicien por una barra, seguida por un asterisco ( /* ) y finalizadas por un asterisco seguido por una barra ( */ ). Cualquier carácter puede incluirse en este tipo de comentario, incluso:

<Enter> o <Return> para cambiar de línea.

Ejemplo:

/*

Este programa tiene el objetivo de controlar el Archivo de clientes.

El usuario tiene la opción de buscar, incluir, modificar, retirar y visualizar la información de cada cliente.

*/

Una única línea

Para incluir solamente una línea de comentario entre las líneas de instrucciones de un programa, deben precederse por dos barras ( // ). En este caso, cualquier carácter después de las barras, hasta el próximo <Enter> o <Return> que cause un cambio de línea, será ignorado por el compilador del AdvPL.

Ejemplo:

// Calcula la facturación neta con base en los Ingresos brutos y en los Gastos.

nDespesa := nOperac + nFinanc

nFatLiq := nRecBrut - nDespesa

Final de una línea

Las barras dobles ( // ) también pueden utilizarse para iniciar un comentario al final de una línea de instrucción del programa. Cualquier carácter que estuviera después de las barras, hasta el final de la línea, serán ignorados por el compilador.

Ejemplo:

nDespesa := nOperac + nFinanc

nFatLiq := nRecBrut - nDespesa    // Calcula la facturación neta con base en los Ingresos brutos y en los Gastos.

Protheus.doc

Este tipo de comentario es el más indicado para documentar la información de una rutina o de funciones. Se trata de una herramienta que lee un encabezado formateado dentro de determinadas reglas para obtener los comentarios y la información de la función, tales como Autor, Fecha, Nombre de la función, Parámetros, Retorno, Versión, etc.

Esta herramienta se explica con más detalles en la página "Documentación del programa con el Protheus.doc", dentro del ítem Buenas prácticas de programación.