阅读和查看 Automation Anywhere 文档

Automation Anywhere

关闭内容

内容

打开内容

注释

  • 已更新:5/10/2019
    • 11.3.x
    • 探索
    • Enterprise

注释

大多数机器人在投入生产后都需要进行更改。可以使用注释帮助更新和维护。

大多数机器人在投入生产后都需要进行更改。有时这些更改很频繁,具体取决于机器人的类型和范围。更改相对简单的任务与极复杂的任务之间差异悬殊,具体是由以下两个因素决定的:机器人架构的清晰程度和机器人的记录及注释情况。

如果注释详尽全面,便可在维护周期中节省数小时的时间。使用相同的语言编写所有注释时,需确保这些注释语法正确且包含适当的标点符号。

一般注释规则

  • 使用重复斜杠、星号或等号为重要内容添加边框:

    使用等号为重要内容添加边框

  • 使用一行注释描述假设、已知问题和逻辑见解,或标记自动执行代码段:

    使用一行注释描述假设

    描述已知问题和逻辑见解。

  • 标记有意义的注释:

    不正确的注释示例

    正确的注释

  • 在使用某些常见短语(比如 //FIX THIS)标识错误的任务行时,务必要使用注释,否则请移除或重写这部分任务!
  • 使用任务列表关键字标记加入注释,以便筛选注释。示例:
    // TODO: Place database command here
    // UNDONE: Removed keystroke command due to errors here
  • 不能在最终生产版本中保留禁用的任务行。请始终删除禁用的任务行。
  • 尝试让注释重点描述命令块的原因和内容,而不描述其方式。尝试帮助读者了解您选择某种解决方案或方法的原因,以及您尝试达成的目标。如果适用,还需提到选择替代解决方案是因为使用常见解决方案时遇到问题。
发送反馈