注释

像其他脚本语言一样,您可以使用 COMMENT 关键字在 ACLScript 中添加注释。 使用注释可使您的代码更容易理解,并且可以与任何尝试阅读、使用或了解您的脚本的人进行交流。

注释类型

ACLScript 支持两个类型的注释:

  • 单行注释 COMMENT 之后的所有文本都被忽略,直至该行末尾为止
  • 多行注释块COMMENT 开始,每个后续行都被忽略,直至到达 END 关键字或空白行为止

单行注释

使用单行注释可描述您的脚本中的单个步骤或者描述变量:

COMMENT *** 分析期间的开始日期
v_Start_Date = `20150101`

多行注释块

使用多行注释块可描述脚本或脚本节。

COMMENT
**********************
** 该脚本的本节为导入操作准备数据
**********************
END

标头注释块

在每个脚本的开头包含一个标头注释块并在其中包含重要的脚本信息是一种好的做法。

COMMENT
************************************************************
*** 脚本名称:   {App_ID}{脚本名称}
*** 参数:    {详细描述}
*** 输出:        {描述参数}
*** 作者:    {姓名}, ABC Corporation, {年份 月份}
*** 修改者:   {姓名}, ABC Corporation, 脚本用途和逻辑
*** 版本:       1.1.1 {app_ver.script_ver.defect.fix}
************************************************************
END