Commande COMMENT

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

Syntaxe

Commentaires sur une seule ligne

COMMENT texte_commentaire

commentaires multilignes

COMMENT 
  texte_commentaire 
  <...n> 
<END>

Remarque

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 ligne saisir le texte entier du commentaire sans saut de ligne
  • commentaire multiligne saisir autant de lignes de commentaire que nécessaire à partir de la ligne qui suit immédiatement la commande COMMENT

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

optionnel

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 du 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 Générer l'écart type et la moyenne. 
STATISTICS ON %v_amt% STD TO SCREEN NUMBER 5 
COMMENT Créer des champs pour stocker l'écart type et la moyenne. 
DEFINE FIELD Ecart_Type COMPUTED STDDEV1 
DEFINE FIELD Moyenne COMPUTED AVERAGE1

Commentaire multiligne

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

COMMENT 
  Cet outil d'analyse identifie les enregistrements multiples ayant des identifiants de créateur de transactions communs 
  (comme l'identifiant de fournisseur ou l'identifiant marchand) 
  où les valeurs des dates de transaction sont égales ou ont un jour d'écart. 
  Cet outil d'analyse peut être utilisé pour les factures ventilées, les bons de commande ventilés, 
  les réquisitions ventilées et les transactions par carte d'entreprise ventilées. 
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.