跳转到内容
搜索文档

注释/提示/警告

最后更新 查看 MarkdownAgent 设置

定义

一种彩色的信息框或旁支内容(包含文本、图像、列表、代码块),用于添加不适合放入正文的相关注释,或警告用户可能破坏功能或影响安全的特定行为。

适用于

操作指南配置常见问题解答概念参考教程

结构

类型:note(注释)或 warning(警告)(定义背景颜色)

旁支内容

(选填)标题/标头

模板

要了解如何排版注释,请参考注释及其他标注类型

渲染示例

什么时候应该使用注释/警告?

使用注释来提醒读者注意无法融入正文的其他有用信息。

使用警告来提醒读者可能影响用户网络安全或破坏功能的行为。

建议

  • 旁支内容不应包含太多内容,因为它会打断正常的文本流。例如,最多 3 个段落,或最多包含 3 个项目的无序列表。如果需要包含更多内容,请考虑创建“重要说明”或类似的文档章节。
  • 克制使用旁支内容。 每个章节不应有多个相同类型的旁支内容。唯一的例外是紧跟在标题后面的关于可用性的声明。
  • 任务步骤说明内部的旁支内容不应有标题。 它们占用太多空间,且背景颜色已足够将旁支内容与常规文本区分开来。
  • 在页面开头使用不带标题的 note 旁支内容来说明某项功能的受限可用性(例如,“仅适用于企业版(Enterprise)计划的客户。”)。

这篇文档对您有帮助吗?