Cursor Project Rules 是 Cursor AI 编码助手的一项强大功能,它能让 AI 深入理解您的项目结构、代码规范和开发上下文。通过提供详细的项目规则文件,Cursor 可以生成更符合您期望的代码,减少误解和错误,提高 AI 编码的准确性和效率。
在 CodeGuide 首页或项目页面中,点击"创建项目"按钮。输入项目标题和详细的项目想法描述,尽可能提供丰富的信息,包括项目目标、核心功能、技术需求等。
提示: 项目想法描述越详细,生成的 Project Rules 就越精准。请至少包含项目类型、主要功能、目标用户和技术偏好等信息。
创建项目后,进入项目工作区,您会看到可生成的文档类型列表。至少生成以下几种文档类型以获得完整的 Project Rules:
注意: 每生成一个文档需消耗 1 点灵石,请确保账户中有足够的灵石。
生成的文档可以单独查看和下载。系统默认
完成 Project Rules 文件后,您可以在 Cursor 编辑器中导入和使用:
提示: 在项目开发过程中,您可以持续更新和完善 Project Rules 文件,以适应项目的变化和新需求。
文件大小没有严格限制,但建议控制在 5,000 到 20,000 字之间。太短可能信息不足,太长可能包含过多细节导致 AI 难以提取关键信息。
可以,您可以为不同的项目方面创建多个规则文件(如架构规则、编码风格规则等),并根据需要分别导入。但首选是一个综合的规则文件以确保一致性。
当然可以!生成的文件只是一个起点,您应该根据实际需求和项目发展进行修改和补充。特别是随着项目的进展,不断更新规则文件将使 AI 更好地适应项目的变化。
不能完全替代。Project Rules 主要是为了指导 AI 编码助手,而传统项目文档还包括更多面向人类团队成员的内容。最佳实践是将 Project Rules 视为项目文档的一个重要补充。
在 Project Rules 中清晰描述产品的最终用户和他们的需求,这有助于 AI 理解代码的目标和上下文。
详细指定您希望的代码风格、命名规则、文件结构和架构模式,确保生成的代码与项目统一。
包含代码示例可以让 AI 更好地理解您期望的实现方式,特别是对于特定的模式或约定。