提示与告警

DocFX 内置五种告警块，写法是在引用块中标注类型关键字。

注意

需要用户注意的信息，即使只是快速浏览也应该看到。

提示

帮助用户更顺利完成任务的可选信息。

重要事项

用户达成目标所必需的关键信息。

小心

可能导致负面后果的操作提示。

警告

一定会导致严重后果的操作提示。

使用场景

类型	建议用途
NOTE	补充说明、背景信息
TIP	技巧、快捷方式
IMPORTANT	必读前提、关键配置
CAUTION	可能导致数据丢失的操作
WARNING	危险操作、不可逆变更