← 全部模板

代码批注 <CodeCallouts />

深色代码窗带行号,被批注的行右侧有编号圆点,右栏是对应编号的说明;每一步点亮一条说明和它的行。

在示例演示里查看 →

分组
技术 · 逐行讲一段代码
组件
CodeCallouts · #code-callouts
交互
build 模式下每按一次 → 点亮下一条说明和它对应的行;未讲到的行仍可读

适合

  • 讲一段配置、SQL、脚本里的关键几行
  • 每条说明对应明确的行

不适合

  • 要对比改动:用 CodeDiff
  • 要演示命令和输出:用 Terminal

内容上限

1code 4–12 行,每行 ≤ 52 个字符
2file ≤ 20 个字符
3notes 2–4 条:title ≤ 10 字,body ≤ 40 字

字段

字段类型
kicker · 必填string标题上方的小节名,2–8 字
title · 必填string | string[]页面标题;传数组可手动断行,每项一行
leadstring一到两句导语,≤ 60 字
sourcestring事实出处;页面上有任何数据或事实时必填
hintReactNode页眉中间的操作提示,可用 <kbd>
code · 必填string[]代码,每项一行
filestring窗口标题
notes · 必填{ lines: number[], title, body }[]批注,lines 从 1 开始
sqlboolean是否高亮 SQL 关键字,默认 true

示例代码

<CodeCallouts kicker="可扩展性" title="…" file="postgis.sql" code={['CREATE EXTENSION postgis;', …]} notes={[{ lines: [1], title: '加载扩展', body: '…' }, …]} />