记事本目前为 Beta 版,未来可能会被弃用。

概述

记事本是 Cursor 中强大的上下文共享工具,弥合了 composers 和 chat 交互之间的差距。可以将它们视为增强的参考文档,超越了 .cursorrules 的功能,允许您为开发工作流程创建可重用的上下文。

记事本充当思想、规则和文档的集合,可以

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

开始使用

  1. 点击记事本部分中的“+”按钮
  2. 为您的记事本命名一个有意义的名称
  3. 以您在 composer 或 chat 中相同的方式添加您的内容、上下文、文件和其他相关信息。
  4. 在 composers 或 chat 中使用 @ 引用它

主要功能

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

常见用例

  1. 动态样板代码生成

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

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

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

FAQ

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

记事本非常适合

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

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

避免使用记事本进行以下操作

  • 临时笔记或草稿
  • 属于版本控制的信息(如 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

此页面对您有帮助吗?