CommentOnText¶
代表用户在 Macro Markdown 或 Word (DOCX) 文档的某段文字上启动一条内联评论,并锚定到所引用的文本。仅在用户明确要求对特定文本进行评论时使用此工具。引用文档中的原文,必须与文档内容完全一致,使用纯文本格式,不包含 Markdown 语法,且位于单个段落、标题、列表项或表格单元格内。如果该文本出现多次,工具会拒绝并列出每次出现的位置,以便您使用 occurrence 参数选择其一,从 1 开始计数;如果找不到该文本,请重新阅读文档,而不是猜测。要评论整个文档或在现有线程中回复,请使用 Comment。此处创建的评论仅保留在 Macro 中,不会写入 Word 文件;若评论需要随 Word 文档一起发送给接收方(例如向交易对手方提供修订标记),请改用 EditWordDocument 的 addComment 操作。
参数¶
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
documentId |
string | 是 | 要评论的文档的 ID。 |
content |
string | 是 | 评论内容,使用 Macro Markdown 格式。其语法与 Markdown 文档相同。 |
quote |
string | 是 | 要评论的文本,必须与文档内容完全一致:纯文本,不包含 ** 或链接括号等 Markdown 语法。只包含评论所针对的文字;引用较长时更有可能唯一匹配。 |
occurrence |
integer | 否 | 要评论的引用文本出现的位置,按文档顺序从 1 开始计数。仅当该文本出现多次时才需要提供。 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 macro3/macro