​

概述

记事本是 Cursor 中强大的上下文共享工具，可弥合作者和聊天交互之间的差距。将它们视为超出.cursorrules，允许您为开发工作流程创建可重用的上下文。

记事本是思想、规则和文档的集合，可以是：

• 在开发环境的不同部分之间共享
• 使用语法引用@
• 通过文件附件进行增强
• 用作各种开发场景的动态模板

​

开始

1. 单击记事本部分中的“+”按钮
2. 为您的记事本指定一个有意义的名称
3. 添加您的内容、上下文、文件和其他相关信息，就像在编辑器或聊天中一样。
4. 在编辑器或聊天中使用@

​

主要特点

• 上下文共享：在编辑器和聊天之间无缝共享上下文
• 文件附件：附加文档和参考文件（在.cursorrules)
• 动态引用：使用提及链接到其他资源@
• 灵活的内容：以适合您需求的方式编写和构建信息

​

常见用例

1. 动态样板生成

   • 为常见 Code Pattern 创建模板
   • 存储特定于项目的基架规则
   • 在整个团队中保持一致的代码结构

2. 架构文档

   • 前端规格
   • 后端设计模式
   • 数据模型文档
   • 系统架构准则

3. 开发指南

   • 编码标准
   • 特定于项目的规则
   • 最佳实践
   • 团队约定

​

常见问题

​

我应该在记事本中写什么？

记事本非常适合：

• 项目架构决策
• 开发指南和标准
• 可重用的代码模板
• 需要经常引用的文档
• 特定于团队的约定和规则

​

记事本不应该写什么？

避免将记事本用于：

• 临时笔记或临时工作
• 属于版本控制的信息（如 git）
• 敏感数据或凭证
• 信息高度波动，变化频繁

​

我应该遵循特定的格式或结构吗？

虽然记事本很灵活，但我们建议：

• 使用清晰的标题和部分
• 在相关的地方包括示例
• 保持内容的专注和有序
• 使用 Markdown 格式以提高可读性
• 必要时添加相关文件附件

​

示例记事本

下面是 Web 应用程序项目的记事本的典型示例：

# API Development Guidelines

## Endpoint Structure
- Use RESTful conventions
- Base URL: `/api/v1`
- Resource naming in plural form

## Authentication
- JWT-based authentication
- Token format: Bearer {token}
- Refresh token mechanism required

## Response Format
{
  "status": "success|error",
  "data": {},
  "message": "Optional message"
} 

## Attached References
@api-specs.yaml
@auth-flow.md