自定义代码片段

有些脚本需要的复杂度比 Studio 操作本身所能提供的要高。 Studio 允许您向脚本中添加自定义代码。 这允许您自定义脚本，以满足您组织的需求。

自定义编码需要一些脚本或编程知识。 Studio 使用名为 Snippet 的自定义编程语言，该语言是为在 Studio 中使用而开发的。 联机帮助中提供了完整的技术参考指南，以便您可以学习使用这种语言。

关于代码片段的关键事实

  • 代码片段可以帮助改进脚本的组织和效率。 它们增强了您对执行流程以及执行时间和执行方式的控制。 您可以创建自己的变量和对象，并使用 IF、FOR、FOREACH 等语句添加编程逻辑。
  • 某些产品和功能需要代码片段，但即使不需要，也可以在脚本中使用它们。
  • 当产品或功能需要代码片段时，联机帮助会提供有关您需要包含的代码片段的详细信息。 提供了脚本示例来展示如何在脚本中使用代码片段。 可能需要额外的脚本来实现产品或功能。
  • Snippet 脚本语言是在 .NET 框架上构建的。 它在服务器端执行，并编译为 MSIL（微软中间语言），如同 C# 和 Visual Basic .NET 一样。

片段操作

要将自定义代码添加到脚本中，您需要一个 Snippet 操作。 您可以双击该操作，打开一个编辑器窗口，然后在其中添加自定义代码。 您还可以在编辑器窗口中调试代码。 您可能需要在脚本中使用多个 Snippet 操作。 如果使用多个操作，请使用有助于识别其用途的短语更新每个操作的Caption字段。

Snippet操作的放置很重要。 如果 Snippet 为变量赋值，则必须将其放置在需要该值的操作之前。 另一方面，如果 Snippet 包含基于传递给它的值进行操作的决策代码，则必须将 Snippet 放置在提供该值的操作之后。

代码段与操作的比较

您可以在片段中执行的一些操作也可以使用 Studio 操作来完成。 例如，有针对 IF 和 FOR 语句的操作。 还有一个 ASSIGN 操作，您可以使用该操作来创建自定义变量并为其赋值。 使用这些操作是将这些功能添加到脚本中的一种可接受方法。 然而，使用代码段的效率更高。

将代码放在代码段中，脚本就会更整洁、更有条理、更易于浏览。 这让脚本编写者的工作变得更轻松、更高效。 如果您养成了始终在代码段中声明变量的习惯，那么将来如果您需要查找特定声明，则需要查找的地方就会更少。

将自定义代码添加到脚本中

该Snippet 操作 允许向脚本中添加自定义代码。 该操作位于“工具”选项卡上默认调色板的“高级”部分。

  1. 在 Studio 中，打开脚本。
  2. 在脚本中需要代码的位置放置 Snippet 操作，并将其连接到其他操作。
  3. 双击该操作，打开编辑器窗口。 您可以在此处添加代码。

  4. 单击要用于添加代码的选项卡。 每个选项卡都提供了不同的代码添加方法。 这些选项卡分别是：

  5. 如果需要，请调试您的代码。

  6. 随时单击 Apply 即可保存更改，而无需关闭编辑器窗口。
  7. 完成代码编辑后，单击 OK。

使用文本视图编写代码

代码片段窗口中的“文本视图”选项卡允许您手动编写Snippet代码。 联机帮助中提供了完整的参考指南，以便您可以学习使用这种语言。

  1. 在 Studio 中，打开脚本。
  2. 将Snippet作添加到脚本中，然后双击它以打开代码片段窗口。
  3. 在“树状视图”选项卡的左侧，输入代码。 您可以键入代码或从其他来源复制并粘贴代码，例如此帮助站点或其他脚本。
  4. 随时单击 Tree View 选项卡，即可从预定义的关键字中添加代码。 您可以使用向上和向下箭头按钮将与关键字相关联的代码移动到脚本中的不同位置。
  5. 单击 Check Syntax 图标 “检查语法”图标，三个绿色小圆圈，其中一个指向右侧的三角形。，验证当前代码的语法是否正确。 如果没有错误，“文本视图”选项卡底部工具栏中的状态字段将显示状态 Okay。 如果出现错误，则会出现有关错误的弹出消息，且工具栏的状态字段会显示一条消息。 例如，消息可能为 Error at line 4。
  6. 单击 Comment 图标“评论”图标，一个左尖括号和一个右尖括号，中间有一条蓝色正斜杠。，将光标当前所在的行转换为注释。
  7. 单击 Uncomment 图标“取消评论”图标，一个大的红色正斜杠叠加在一个左尖括号和一个右尖括号上，中间有一个正斜杠。，从光标当前所在的行中移除注释字符。
  8. 随时单击 Apply 即可保存更改，而无需关闭编辑器窗口。
  9. 完成代码编辑后，单击 OK。

带有文本视图的代码

“代码段属性”窗口中的“树状视图”选项卡将指导您完成创建自定义代码的流程。 一组预定义的关键字可供您选择。

  1. 在 Studio 中，打开脚本。
  2. 将 Snippet 操作添加到脚本中，然后双击打开“代码段”窗口。
  3. 单击“树状视图”选项卡底部的加号图标 一个加号，旁边有一个向下的箭头。。

  4. 代码段属性窗口，显示“树状视图”选项卡。 按下绿色加号图标，即可看到代码片段命令菜单。

    选择要添加到代码中的关键字。
  5. 单击窗口左侧列表中显示的关键字，查看其属性。

  6. 在窗口右侧的列表中配置关键字的属性。 您可以：

    • 选择每个属性可在右窗格下方的空间中查看该属性的定义。
    • 有关配置每个命令的详细信息，请参阅本页上的代码段关键字部分。
  7. 根据需要添加更多关键字。
  8. 随时单击 Text View 选项卡，查看以传统编码格式编写的代码。
  9. 随时单击 Apply 即可保存更改，而无需关闭编辑器窗口。
  10. 完成代码编辑后，单击 OK。

调试代码片段

Snippet 操作有自己的调试器，可以用来检查代码。 您只能从“文本视图”选项卡调试代码。

如果在“树状视图”选项卡上创建代码，则切换到“文本视图”选项卡即可使用调试器。 如果调试器发现任何问题，请使用指定的行号来确定代码的哪一部分包含问题。 然后，您可以返回“树状视图”选项卡来纠正问题。

提供更多调试选项，包括逐行执行代码和使用断点。 您还可以在调试过程中，使用代码片段中的 TRACE 语句来输出文本。 在解决脚本中的问题时，此输出非常有用。

  1. 在 Studio 中，打开一个包含 Snippet 操作的脚本。
  2. 双击 Snippet 操作。
  3. 如果尚未包含某些代码，请在 Text View 选项卡上添加 Snippet 代码。
  4. 在 Snippet editor 窗口的右侧，单击 Debugger 选项卡。
  5. 单击 Debug 图标 右侧的向下箭头按钮，然后选择 Start绿色播放按钮三角形的图标。。

  6. 如果代码中有任何语法错误，Snippet editor 窗口就会展开。 代码中的所有错误都显示在窗口底部的窗格中。 如果没有错误，请跳至下一步。

    代码片段编辑器窗口，显​​示窗口底部的错误窗格。
    1. 纠正错误。
    2. 纠正错误后，单击 Close 或 Clear Trace Output 图标关闭错误窗格。
    3. 再次启动调试器。
  7. 查看 Variables as Text 选项卡的内容。 如果未设置断点，则在所有代码执行完毕后，该选项卡会显示变量及其值。
  8. 您可以选择代码片段中的一行或多行，然后单击 Comment out selected lines 图标。 如果您想删除一些代码以查看调试结果如何变化，这将很有帮助。
  9. 您可以选择一行或多行注释代码，然后单击 Uncomment the selected lines 图标 将这些行添加回代码段中。