记事本

了解如何使用记事本在作曲家和聊天之间共享上下文

记事本目前处于测试阶段

概述

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

Image 1

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

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

开始使用

  1. 点击记事本部分的“+”按钮
  2. 给您的记事本一个有意义的名称
  3. 以与作曲家或聊天相同的方式添加内容、上下文、文件和其他相关信息。
  4. 在作曲家或聊天中使用@进行引用

Image 2

主要功能

  • 上下文共享:在作曲家和聊天之间无缝共享上下文
  • 文件附件:附加文档和参考文件(在.cursorrules中不可用)
  • 动态引用:使用@提及链接到其他资源
  • 灵活内容:以适合您需求的方式编写和结构化信息

常见用例

  1. 动态模板生成

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

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

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

常见问题

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

记事本非常适合:

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

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

避免在记事本中使用:

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

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

虽然记事本是灵活的,但我们建议:

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

示例记事本

以下是一个典型的Web应用程序项目的记事本示例:

记事本示例

复制

# API 开发指南

## 端点结构

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

## 认证

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

## 响应格式

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

## 附加参考

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