COMMENT 命令

将解释性备注添加到脚本中而不影响处理。

语法

单行批注

COMMENT comment_text

多行批注

COMMENT
  comment_text
  <...n>
<END>

说明

不要在注释文本行前面使用脱字符 ^。.acl 项目文件中的脱字符具有特殊用途,如果您在注释文本前面加上脱字符,则该文本不会被保存。

参数

名称 描述
注释文本

正在添加的批注。

  • 单行注释输入不带换行符的整个注释文本
  • 多行注释从 COMMENT 命令后紧接的行开始,可根据需要输入任意行数的注释文本

    多行注释应以单独一行中的 END 关键字结束,或以空行结束。

END

可选

多行 COMMENT 命令的结尾。

如果您使用 END,则必须在紧随最后一个批注行的行上输入它。如果您省略 END,则在最后一个批注后面必须紧跟一个空白行。

示例

单行批注

您可以在命令之前使用单行批注,以供将来维护该脚本的用户阅读:

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

多行批注

您可以使用多行注释来开始您编写的每个脚本,以介绍该脚本的用途:

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

备注

何时使用 COMMENT

使用 COMMENT 包括有关脚本的用途、所使用的逻辑的信息,以及脚本所需的输入和您定义的每个变量的用途等其他信息。

每次脚本运行时,该脚本中的批注会被写入 Analytics 命令日志。