Notepads(测试版)

本指南介绍如何在 Cursor 中使用 Notepads,在 Composer 和 Chat 交互之间共享上下文。

Notepads 目前处于测试阶段,未来可能会被弃用。

概述

Notepads 是 Cursor 中强大的上下文共享工具,能够弥合 Composer 和 Chat 交互之间的鸿沟。你可以将其视为增强版的参考文档,功能超越了 .cursorrules,允许你为开发流程创建可复用的上下文。

Notepads

Notepads 可以作为想法、规则和文档的集合,具备以下用途:

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

入门

  1. 点击 Notepads 区域的“+”按钮
  2. 为你的 Notepad 命名
  3. 添加内容、上下文、文件及其他相关信息,方式与在 Composer 或 Chat 中相同
  4. 在 Composer 或 Chat 中通过 @ 引用 Notepad
Notepads

主要特性

  • 上下文共享:在 Composer 和 Chat 之间无缝共享上下文
  • 文件附件:可附加文档和参考文件(.cursorrules 不支持)
  • 动态引用:使用 @ 提及链接到其他资源
  • 灵活内容:以适合你的方式编写和组织信息

常见用例

  1. 动态样板代码生成

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

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

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

常见问题

Notepads 适合写什么?

Notepads 非常适合用于:

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

Notepads 不适合写什么? 不建议将 Notepads 用于以下内容:

  • 临时笔记或草稿
  • 应该放在版本控制(如 git)中的信息
  • 敏感数据或凭证
  • 频繁变动的高波动性信息

需要遵循特定格式或结构吗?

Notepads 很灵活,但建议:

  • 使用清晰的标题和分节
  • 相关内容处添加示例
  • 保持内容聚焦和有条理
  • 使用 markdown 格式提升可读性
  • 必要时添加相关文件附件

Notepad 示例

以下是一个 Web 应用项目的 Notepad 示例:

# API 开发规范

## 接口结构
- 遵循 RESTful 规范
- 基础 URL: `/api/v1`
- 资源命名使用复数形式

## 认证
- 基于 JWT 的认证
- Token 格式:Bearer {token}
- 需要支持刷新 token 机制

## 响应格式
{
  "status": "success|error",
  "data": {},
  "message": "可选消息"
}

## 附件参考
@api-specs.yaml
@auth-flow.md