.qoder/rules
目录中,仅对当前项目生效。它们可优化模型对你的编码偏好的适配,包括项目所用框架与代码风格。
规则如何工作
存储与共享
- 规则文件直接存放在项目目录中,并通过 Git 等版本控制系统与团队成员共享,与代码库一同管理。
- 对于仅本地使用(不共享)的规则,请将
.qoder/rules
目录添加到项目的.gitignore
文件中。
限制
- 所有活跃规则文件合计最多允许 100,000 个字符(超出部分将被截断)。
- 仅支持自然语言,不支持图片或链接。
规则类型
类型 | 描述 | 使用场景 |
---|---|---|
手动引入 | 通过智能会话面板或行间会话使用 @rule 手动应用。 | 按需工作流,自定义提示词 |
模型决策 | 模型在智能体模式下评估规则描述并决定何时应用。 | 场景化任务(例如生成单元测试或代码注释) |
始终生效 | 适用于所有智能会话和行间会话请求。 | 强制执行项目级标准(例如编码风格或文档格式) |
指定文件生效 | 适用于匹配通配符模式的所有文件(例如 .js 或 src/**/.ts )。 | 语言或目录特定的规则 |
最佳实践
- 保持简洁:让规则聚焦且明确无歧义。
- 结构清晰:使用项目符号、编号列表或 Markdown 格式以提升可读性。
- 包含示例:提供“良好”的代码示例以指导模型。
- 迭代与优化:根据模型输出和反馈不断完善规则。
配置规则
- 在 Qoder IDE 右上角,点击用户图标或使用键盘快捷键(
⌘
⇧
,
(macOS)或Ctrl
Shift
,
(Windows)),然后选择 Qoder 设置。 - 在左侧导航窗格中,点击 规则。
- 点击 添加。
- 在顶部搜索栏中,输入唯一的规则名称并按 确认。
- 选择规则类型:
- 手动引入
- 模型决策:输入场景描述。
- 示例:“生成一个单元测试.”
- 指定文件生效:提供以逗号分隔的文件路径通配符。
- 示例:
*.md
、src/*.java
。
- 示例:
- 始终生效
- 关闭窗口以保存更改。