使用注释的准则

注释用于向脚本添加信息。 注释应添加相关信息。

使用行注释记录复杂逻辑

使用行注释可记录包含复杂逻辑的代码块。 您不可能始终避免解决方案的复杂性增加，但您应记录复杂代码的片段，以改进脚本的可维护性。

包含导致该复杂解决方案的所有理由。 记录原因、限制以及片段执行的复杂逻辑。

下图说明了此概念。

行注释摘录

记录不明确的命令

当命令在代码中的用途不明确时，使用命令注释来记录该命令的用途。 例如，您可能需要发送键盘输入来激活应用程序中的事件。 记录此命令以说明其使用原因。

使用命令注释来记录受命令影响的图形界面控件。 某些选择器可能不是那么明确地指定哪个控件是命令操作的目标。 在这些情况下，记录哪些控件是目标可提高代码的可维护性。

下图说明了此概念。

命令注释摘录

在脚本中包含头

在脚本开头包含结构化行注释，以构成包含脚本相关信息的头。 在头中，必须插入如下等信息：

  • 脚本功能的描述
  • 有关脚本功能的特殊性
  • 在特殊情况下使用的指示信息
  • 脚本输入参数及其各自函数的列表
  • 脚本输出参数及其各自函数的列表

下图说明了此概念。

标题注释摘录

除去注释的代码

在测试和调试期间，可以注释掉代码以尝试不同的解决方案。 在这些测试结束时，在发布之前，从代码中除去任何注释的命令。 IBM RPA 版本控制系统足以确保您可以根据需要恢复已除去的代码片段。