青蛙小白
博客 / 2025/01

Cursor的NotePads

2025/01/18 · — 字 · 阅读约 — 分钟 ·
目录

在Cursor中使用Notepads在Composer和Chat之间共享上下文。

Notepads是Cursor中强大的上下文共享工具,弥合了Composer和Chat之间的差距。可以将Notepad视为超越.cursorrules功能的增强型参考文档,允许为开发工作流创建可重复使用的上下文。

Notepads可以是以下内容的想法、规则和文档集合:

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

开始使用

  1. 在Notepads部分单击“+”按钮
  2. 给创建的Notepad起一个有意义的名字
  3. 与Composer或Chat中相同的方式添加内容、上下文、文件和其他相关信息
  4. 在Composer或Chat中使用@引用它(@Notepad)

主要功能

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

常见用例

动态样板代码生成

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

架构文档

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

开发指南

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

FAQ

应该在Notepads中写什么?

  • 项目架构决策
  • 开发指南和标准
  • 可重复使用的代码模板
  • 需要经常参考的文档
  • 团队特定的惯例和规则

不应该在Notepads中写什么?

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

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

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

Notepads示例

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

# 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

参考

评论