CodeBuddy-Rules配置

Posted on 2025-12-01 13:31  Java后端的Ai之路  阅读(0)  评论(0)    收藏  举报

定义 Rules

您可以在 Rules 配置页中定义您的 User RulesProjectRules


define.Dyt3-bEV.png

User Rules

可以定义您的个人偏好,例如编码风格、通用要求、常用指令或习惯。定义好后,这些 Rules将会自动发送给 AI 模型,应用到所有的 chats 、composers 和 Command -K 中。并且定义的这些 Rules 将在您的CodeBuddy IDE 账户中生效,无论当前是在哪个项目。

user_rules.IbVqmX_b.png

Project Rules

定义项目级别的 Rules,例如编码规范、框架约定、库使用规则、安全要求,这些Rules 将在当前项目中生效,并且 Agent 会自动识别和获取到这些 Rules。

project_rules.DGmqf7T1.png

Rule type

在 Project Rules 中,按触发方式的不同可分为下面三种类型:

  • Always: 用于在每次对话和内联请求中触发。
  • Agent Requested:由 Agent 根据任务描述决定是否引用。
  • Manual:通过 @RuleName 引用时触发。

在创建 Project Rules 时根据实际场景选择。

rule_type.mhR2_3Ju.png

引用 Rules

如果您定义的 Rules 是 Manual Type,在对话框中,您可以通过 @ 符号引用定义好的 Rules文件,Rules 文件中的 Project Rules 将会应用到模型的上下文中。

reference.CmlFMWU8.png

个人常用Rules配置

项目规则(Project Rules):存放于项目目录下的 .cursor/rules 中,只用于约束当前项目:

1、之前完成正确的功能,尽量不要修改。
比如当前的instruction是完善功能A的,那么只需要专注功能A,不需要修改其他功能(比如功能B)。
2、生成的注释用中文,并使用 UTF-8 编码。
3、生成的代码有时候会存在中文乱码的情况,所以你在生成中文的时候,需要检查是否有中文乱码,如果有乱码需要修正。
4、如果修改某个函数的实现,先理解之前函数实现的逻辑。然后在原来的基础上,再进行修改(保留之前的函数逻辑,不要移除)
5、你操作的环境是windows系统
6、如果用户没有明确说,就不需要编写测试脚本,也不需要写专门的项目说明 .md

全局规则(User Rules):针对所有项目通用的规则:

1、中文回复
2、不需要写测试脚本
3、只需要完成用户的需求,不需要创建更详细的分析脚本,即新的重复的脚本
4、不需要帮客户安装其他的Python包,即不要主动 pip install
5、不要用mock数据,不要fallback

博客园  ©  2004-2025
浙公网安备 33010602011771号 浙ICP备2021040463号-3