blob: 1594fe4db6f5968da6cc1ee5bc4cd171239eb546 [file] [view]
# 文档格式规范
## 注释说明
注释说明在技术文档中起强调作用。在使用中,需遵循以下规范:
- 根据提示内容,可以将注释分为“提示”、“备注”、“注意”三类。注释框标题与使用场景请遵循以下规范:
- 提示:主要用于操作技巧提示
- 备注:用于补充内容补充解释
- 注意:用于操作、注意事项警告
- 提示框内容可以使用有序、无序、代码块
下面是 Markdown 文档中注释说明示例:
```Markdown
:::tip 提示
这是一条提示
:::
:::info 备注
这是一条备注
:::
:::caution 注意
这是一条注意事项
:::
```