在日常开发中,AI 的回答往往基于训练数据的"记忆",如果你的项目使用了特定版本的框架、内部 SDK 或团队自定义规范,直接提问很容易得到过时或不符合约定的代码。@文档(@Docs)指令允许你将外部信息源直接注入对话上下文,让 AI 基于准确的文档而非猜测来作答。
适用场景
- 跟进最新版本:框架升级后 API 有变动(如 React 19 新特性、Prisma 5.x 语法),引用官方最新文档避免 AI 给出旧版写法。
- 落地团队规范:将《前端开发规范.md》《接口命名约定.md》等内部文档添加为知识源,AI 在生成和重构代码时自动遵循。
- 复杂业务规则:项目有特定的字段映射、校验逻辑或缩写约定,将这些规则写成
.cursorrules文件或 Markdown 文档供 AI 随时查阅。
操作方法
- 在侧边栏对话输入框或行内编辑框(
Ctrl/Cmd + K)中,输入@唤起菜单,选择 @Docs。 - 首次使用需建立文档源,点击 "Add new doc":
- URL 源:粘贴公开的技术文档地址(如官方文档站点),Cursor 会自动抓取并建立索引;
- 本地文件:选择项目内的
.md、.txt或.cursorrules文件,内容直接嵌入上下文; - 规则文件:在项目根目录创建
.cursorrules文件写入项目级约束,通过@Docs引用后,AI 会在后续相关对话中自动遵从。
- 文档源添加后,再次输入
@Docs即可看到已索引的列表,选中对应文档再输入具体问题。
实用示例
| 场景 | 输入示例 |
|------|---------|
| 查最新 API | @Docs React官方文档 use hook 的用法和限制 |
| 按规范检查 | @Docs 团队规范 这段异常处理是否符合我们的日志标准 |
| 按规则生成 | @Docs .cursorrules 根据项目约定生成用户模块的 DTO |
注意事项
- 索引更新:URL 抓取的文档不会实时同步,若官方文档已更新但 AI 引用的是旧内容,需在设置中找到对应文档源点击 Re-index 手动重建索引。
- 上下文占用:长篇文档会消耗大量 Token,可能导致对话中早期引用的代码被挤出上下文窗口。建议将规则拆分为数个小文件(如按模块分),或提问时尽量具体,避免一次性加载整本手册。
- 隐私安全:本地添加的内部文档仅用于构建本地上下文,不会用于模型训练,但涉及核心商业机密的文档仍建议脱敏后使用,或优先通过本地
.cursorrules文件控制范围。