表格与代码
表格与代码块是技术文档的两大主力呈现:表格用 | 组织结构化数据,代码块用围栏标注程序片段。前者把对比信息变成一眼可扫的矩阵,后者让代码保持原始格式并获得语法高亮。配合 Markdown 总览与 文本格式 的排版骨架使用。
提示
表格适合"多行同构"的数据(对比、参数、清单);代码块适合任何程序片段。判断标准:信息是不是"每行同一套列"——是就用表格,不是就用列表或段落。
表格
使用 | 分隔单元格,- 分隔表头和其他行:
name | price
--- | ---
fried chicken | 19
cola | 5| name | price |
|---|---|
| fried chicken | 19 |
| cola | 5 |
为了使 Markdown 更清晰,
|和-两侧需要至少有一个空格(最左侧和最右侧的|外就不需要了)。
Typora: CTRL+T 快速插入表格
代码块
用三个反引号包裹并标注语言名称,获得对应语法高亮:
```语言名称
代码内容
```public static void main(String[] args) {
System.out.println("Hello");
}Typora: CTRL+SHIFT+K
语言标签的价值
语言标签(如 ```java、```python)告诉渲染器使用哪种语法高亮规则。没有语言标签的代码块不会高亮,可读性差。Obsidian、GitHub、Typora 等工具都支持语法高亮。
行内代码
用单个反引号包裹,适合引用命令、变量名等短代码:
例如 `Markdown`、`git commit`、`npm install`例如 Markdown、git commit、npm install
Typora: CTRL+SHIFT+`
转换规则:代码块中的文本(包括 Markdown 语法)都会显示为原始内容——想展示
**加粗**这种"语法本身"时,把它放进代码块即可。
跳出表格与代码本身看:结构化数据用表格、程序片段用代码块,配合 链接与图片 的引用能力,技术文档的"文、数、码、图"四要素就齐了。