跳到主要内容

方案注释指南

预计学习时间:7分钟

方案注释可以帮助您记录和与其他Make平台用户共享关于您方案的关键细节。注释是提供上下文、操作指南或解释方案不同组成部分的有效方式。 在开始使用注释之前,请注意:

  • 您可以在任何方案的模块或路径上附加注释。
  • 每个模块或路径最多可以包含200条注释。
  • 每则注释的字符上限为10,000个字符。
  • 当您使用大量格式化内容,比如表情符号和链接时,可能会比未使用格式化时更快达到字符限制。
  • Make平台会以HTML格式存储您的注释,此格式会因格式设置而使用更多字符。

创建注释

如何向模块或路径添加注释: 1 在您想要添加注释的模块或路径上右键点击。 2 从弹出的上下文菜单选择添加注释。 3 在文本编辑器中录入您的内容。 文档图片

4 可选:使用格式化工具栏为您的文本添加样式,插入链接或表情符号。 5 点击确认以保存您的注释。 模块附加注释

路径附加注释

查看注释

在方案中查看注释的几种方式:

操作您将看到的内容
鼠标悬停在注释标记上注释内容的预览
单击注释标记一次可滚动查看完整的注释内容
点击工具栏中的便签图标打开显示所有方案注释预览的注释面板
提示:双击注释可直接进入编辑状态。

管理注释

编辑注释的步骤: 1 双击您需要修改的注释。 2 在文本编辑器中进行更改。 3 点击确认以保存更新,或点击取消以放弃修改。 删除注释的步骤: 1 打开您想删除的注释。 2 点击注释窗口右上角的垃圾桶图标。 3 按照提示确认您要删除这条注释。 注意,删除注释后,此操作是不可逆的。

最佳实践

  • 利用注释记录复杂逻辑或阐释不明显的工作流决策。
  • 添加执行细节,以便团队成员更好地理解您的方案。
  • 记录模块所需的特定要求或依赖性。
  • 阐释不同路径的目的,明确工作流程中的分支。
  • 保持注释内容精简而信息丰富,以提高团队合作效率。