Commentaires

Comme dans tout langage de script, il est possible d'ajouter des commentaires dans ACLScript avec le mot-clé COMMENT. Les commentaires facilitent la compréhension de votre code et sa communication auprès d'utilisateurs cherchant à lire, à utiliser ou à comprendre votre script.

Types de commentaires

ACLScript prend en charge deux types de commentaires :

• commentaires d'une seule ligne l'intégralité du texte qui suit COMMENT est ignorée jusqu'à ce que la fin de la ligne soit atteinte
• blocs de commentaires sur plusieurs lignes commencent par COMMENT et les lignes qui suivent sont ignorées tant que le mot-clé END ou une ligne vide n'est pas atteint

Commentaires d'une seule ligne

Les commentaires d'une seule ligne permettent de décrire des étapes individuelles de votre script ou de décrire des variables :

COMMENT *** la date de début de la période d'analyse
v_Date_début = `20150101`

Blocs de commentaires sur plusieurs lignes

Les blocs de commentaires sur plusieurs lignes servent à décrire des scripts ou des sections de script.

COMMENT
**********************
** Cette section du script prépare les données pour l'importation
**********************
END

Blocs de commentaires d'en-tête

Il est recommandé d'inclure un bloc de commentaires d'en-tête qui contient des informations clés sur le script au début de chaque script :

COMMENT
************************************************************
*** Nom du script :   {ID_App}{Nom du script}
*** Paramètres :    {Description détaillée}
*** Sortie :        {Décrire les paramètres}
*** Rédigé par :    {Nom}, Entreprise ABC, {Mois AAAA}
*** Modifié par :   {Nom}, Entreprise ABC, objectif et logique du script
*** Version :       1.1.1 {app_ver.script_ver.defect.fix}
************************************************************
END