Comentarios
Como en un lenguaje de scripts, en ACLScript puede agregar comentarios usando la palabra claveCOMMENT. Utilice los comentarios para que el código sea más fácil de comprender y para comunicarse con cualquier persona que intente leer, utilizar o comprender su script.
Tipos de comentarios
ACLScript admite dos tipos de comentarios:
- comentarios de una sola línea se ignora todo el texto que sigue a COMMENT hasta llegar al final de la línea
- bloques de comentario de varias líneas comienzan con COMMENT y se ignora cada una de las líneas siguientes hasta llegar a la palabra clave END o una línea en blanco
Comentarios de una sola línea
Utilice comentarios de una sola línea para describir los pasos individuales de su script o para describir las variables:
COMMENT *** la fecha de inicio para el período de análisis
v_fecha_de_inicio = `20170701`
Bloques de comentarios de varias líneas
Utilice bloques de comentarios de varias líneas para describir scripts o secciones de scripts.
COMMENT
**********************
Esta sección del script prepara los datos para la importación
**********************
END
Bloques de comentario de encabezado
Es una práctica recomendable incluir, al principio de cada script, un bloque de comentario de encabezado que contenga información del script clave:
COMMENT
************************************************************
*** Nombre del script: {ID_App}{Nombre del script}
***Parámetros: {Descripción detallada}
***Salida: {Describir los parámetros}
*** Escrito por: {Nombre}, ABC Corporation, {Mes AAAA}
*** Modificado por: {Nombre}, ABC Corporation, finalidad y lógica del script
*** Versión: 1.1.1 {ver_app.ver_script.defecto.fix}
************************************************************
END