文档 / 功能 / 记事本

记事本

记事本目前处于测试阶段

概述

测试阶段功能

记事本目前处于测试阶段，功能可能会有所变化。我们欢迎您的反馈，帮助我们改进这一功能。

记事本是Cursor中强大的上下文共享工具，弥合了作曲家与聊天互动之间的差距。可以将其视为增强的参考文档，超越了.cursorrules的能力，使您能够为开发工作流程创建可重用的上下文。

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

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

开始使用

1. 创建记事本

在左侧导航栏的记事本部分，点击"+"按钮创建新记事本。

提示： 为记事本选择一个描述性的名称，以便于日后查找和引用。

2. 添加内容

向记事本中添加相关信息、规则、指南和参考文档。支持以下内容：

  • 文本说明和指南
  • 代码示例和模板
  • 文件附件（使用@files语法）
  • 链接到其他资源

注意： 记事本支持Markdown格式，使用Markdown可以创建更具结构和可读性的内容。

3. 使用记事本

在Cursor的任何交互中引用记事本，方法如下：

  1. 在作曲家或聊天中，输入@字符
  2. 从弹出的建议中选择您的记事本
  3. Cursor将自动将记事本的内容应用到当前上下文

记事本内容将被视为重要的上下文信息，AI会优先考虑这些内容来指导生成。

主要功能

上下文共享

在作曲家和聊天之间无缝共享上下文，确保AI始终了解项目的要求和规范。

  • 同时在多个会话中引用
  • 作为指导AI行为的持久规则
  • 跨团队成员共享，确保一致理解

文件附件

附加文档和参考文件，提供更丰富的上下文信息，这在.cursorrules文件中是不可用的功能。

  • 支持代码文件
  • 可添加配置文件
  • 包含架构图
  • 引用API规范文档

动态引用

使用@提及语法链接到其他资源，创建互联的知识网络。

  • 引用其他记事本
  • 链接代码片段
  • 关联文件和文件夹
  • 连接在线资源

灵活内容

以最适合您需求的方式编写和结构化信息，没有固定的格式限制。

  • 支持Markdown格式
  • 可以包含代码块
  • 支持列表和表格
  • 按主题分组信息

常见用例

动态模板生成

创建和存储项目专用的模板，确保团队开发的一致性。

  • 为常见代码模式创建模板
  • 存储项目特定的脚手架规则
  • 在团队中保持一致的代码结构

架构文档

集中存储和管理项目架构信息，便于团队成员快速理解系统结构。

  • 前端规范
  • 后端设计模式
  • 数据模型文档
  • 系统架构指南

开发指南

统一开发标准与实践，减少团队沟通成本，提高代码质量。

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

快速参考

创建常用命令、配置和操作的便捷参考，提升日常开发效率。

  • 常用API参考
  • 工作流程说明
  • 环境配置指南
  • 故障排除步骤

常见问题

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

记事本非常适合：

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

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

避免在记事本中使用：

  • 临时笔记或草稿
  • 属于版本控制的信息（如git）
  • 敏感数据或凭证
  • 频繁变化的高度不稳定信息

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

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

  • 使用清晰的标题和章节
  • 在相关的地方包含示例
  • 保持内容集中和有序
  • 使用markdown格式以提高可读性
  • 在必要时添加相关的文件附件

示例记事本

以下是一个API开发指南记事本的示例，展示了如何组织和格式化记事本内容：

记事本内容示例：

# API 开发指南

## 端点结构

- 使用RESTful约定
- 基础URL: `/api/v1`
- 资源命名为复数形式

## 认证

- 基于JWT的认证
- 令牌格式: Bearer {token}
- 需要刷新令牌机制

## 响应格式

{
  "status": "success|error",
  "data": {},
  "message": "可选消息"
}

## 附加参考

@api-specs.yaml
@auth-flow.md

使用上述格式，您可以轻松引用此记事本并将其知识应用于代码生成和问题解决中。