应根据上下文选择 HTML 标签:单个参数名用 <code>,JSON 或带查询参数的 URL 必须用 <pre><code> 组合并转义特殊字符,且需文字说明参数位置。

直接用 <code> 标签包裹接口参数名或简单结构是错的——它不保留换行、缩进,也不转义 HTML 字符,JSON 或 URL 参数一粘就崩。
接口参数是单个字段名时,用 <code> 最安全
比如文档里提一个查询参数 page 或请求体字段 user_id,<code> 正好匹配语义和渲染行为:
-
page✅ 行内、等宽、无障碍友好,浏览器读作“page 字段” -
sort_by=created_at✅ 短小 URL 参数,无<code>>&,可直接写 -
Content-Type: application/json✅ 冒号分隔的 header 名值对,也适用 - 别写
{"id": 1}❌ 含{}和引号,虽不报错但语义错(这是数据,不是字段名)
展示 JSON 请求体或 QueryString 必须用 <pre><code> 组合
哪怕只是两行 JSON,<code> 单独用会压成一行,缩进全丢,且 <code>> & 不转义就会被解析为标签,导致 DOM 错乱。
- 先手动转义:把
换成 <code><,>换成>,&换成& - 再套结构:
{ "user_id": 123, "status": "active" } - 注意
class="json"要加在<code>上,否则 highlight.js 不识别 - 别漏掉
<pre>—— 没它,换行和缩进全失效
URL 中带参数时,<code> 只能包路径段,不能包整个带 query 的 URL
像 https://api.example.com/v1/users?id=1&limit=10 这种,直接塞进 <code> 会因 & 解析失败。更稳妥的做法是拆解:
立即学习“前端免费学习笔记(深入)”;
- 路径部分用
<code>:/v1/users - 参数部分单独列,每个参数用
<code>包:id、limit - 完整 URL 放
<pre><code>里,且必须转义:https://api.example.com/v1/users?id=1&limit=10
- 别信“浏览器能自动处理”,
&在 HTML 属性或文本中都必须写成&
最容易被忽略的是:接口参数从来不是孤立字符串,它依附于上下文(是 query?header?body?),而 <code> 本身不携带这个信息——你得靠文字说明补全,或者用 title 属性提示,比如 Authorization。



















