Commande COMMENT

Ajoute un commentaire d'explication à un script sans affecter le traitement.

Syntaxe

Commentaires sur une seule ligne

COMMENT comment_text

Commentaires multilignes

COMMENT
  comment_text
  <...n>
<END>

Note

N'utilisez pas le caractère caret ^ avant des lignes de texte de commentaire. Le caret a une utilisation spéciale dans le fichier de projet .acl et le texte de commentaire n'est pas enregistré si vous le faites précéder d'un caret.

Paramètres

Nom Description
texte_commentaire

Commentaire que vous ajoutez.

  • Commentaire sur une seule ligneSaisir le texte entier du commentaire sans saut de ligne
  • Commentaire multiligneSaisir autant de lignes de commentaire que nécessaire à partir de la ligne qui suit immédiatement la commande COMMENT

    Terminez un commentaire multiligne avec le mot-clé END sur une ligne séparée ou sur une ligne vide.
END

facultatif

Fin d'une commande COMMENT multiligne.

Si vous utilisez END, cette instruction facultative doit être saisie sur la ligne suivant immédiatement la dernière ligne du commentaire. Si vous ignorez END, une ligne vide doit suivre la dernière ligne de commentaire.

Exemples

Commentaires sur une seule ligne

Vous utilisez des commentaires d'une seule ligne avant les commandes pour ajouter de la documentation destinée aux utilisateurs futurs qui mettront le script à jour :

COMMENT Generate the standard deviation and average.
STATISTICS ON %v_amt% STD TO SCREEN NUMBER 5
COMMENT Create fields for storing standard deviation and average.
DEFINE FIELD Standard_Dev COMPUTED STDDEV1
DEFINE FIELD Average COMPUTED AVERAGE1

Commentaire multiligne

Vous commencez chaque script que vous rédigez par un commentaire multiligne expliquant l'objectif du script :

COMMENT
  This analytic identifies multiple records having common
  transaction originator IDs (like vendor ID or merchant ID)
  where the transaction date values are either equal or one day apart.
  This analytic can be used for split invoices, split purchase orders,
  split requisitions, and split corporate card transactions.
END

Remarques

Quand utiliser COMMENT

COMMENT permet d'inclure des informations relatives à la portée d'un script, à la logique utilisée et d'autres informations telles que les entrées requises pour le script et l'objectif de chaque variable que vous définissez.

Les commentaires d'un script sont écrits dans la trace de la commande Analytics à chaque exécution du script.