[条目标题]¶
类型:wiki(知识沉淀) 描述:[一句话讲这是什么 — 用于 INDEX] 最后更新:YYYY-MM-DD(v0.x.y) 相关源码:
src/path/to/file.ts/src/path/to/another.tsx相关 rules:docs/rules/xxx.md(可选)
是什么¶
[用 1-2 段话讲清楚这个东西的核心概念,避免堆细节。读完这段应该能向别人解释「这是什么」]
为什么这么设计¶
[设计动机 / 历史背景 / 替代方案的权衡。引用具体的历史版本和教训]
关键代码位置¶
| 文件 | 行号附近 | 作用 |
|---|---|---|
src/foo.ts |
function bar() |
xxx |
字段 / API 速查¶
[表格、代码块、流程图,自由组织]
易踩坑 / 注意点¶
- ⚠️ [坑 1:症状 → 原因 → 正确做法]
- ⚠️ [坑 2]
修改这块时要 / 不要做什么¶
- ✅ 改 X 时记得同步改 Y
- ❌ 不要直接删 Z(会破坏 A)
相关版本里程碑¶
| 版本 | 事件 |
|---|---|
| v0.x.y | 最初引入 |
| v0.a.b | 重大调整:xxx |