Skip to main content

规则

Qoder CN IDE 支持项目级规则和用户级规则。项目规则存放于 .qoder/rules 目录,仅对当前项目生效。创建时先选择作用范围,再配置生效条件,用于约定编码风格、框架用法等偏好。

规则如何工作

大型语言模型(LLMs)依赖通用知识,因此缺乏你项目特定的上下文和规则。Qoder CN IDE 的规则通过将预定义的上下文有策略地注入到提示中来弥补这一不足,从而引导 AI 的回答更一致地符合你项目的标准和要求。

存储与共享

作用范围目录
用户级~/.qoder-cn/rules/
项目级项目根目录下的 .qoder/rules/
项目规则可随 Git 共享。仅供本地使用的项目规则可将 .qoder/rules/ 加入 .gitignore。

限制

  • 所有活跃规则文件合计最多允许 100,000 个字符(超出部分将被截断)。
  • 仅支持自然语言,不支持图片或链接。

规则类型

类型描述使用场景
手动引入通过智能会话面板或行间会话使用 @rule 手动应用。按需工作流,自定义提示词
模型决策模型在智能体模式下评估规则描述并决定何时应用。场景化任务(例如生成单元测试或代码注释)
始终生效适用于所有智能会话和行间会话请求。强制执行项目级标准(例如编码风格或文档格式)
指定文件生效适用于匹配通配符模式的所有文件(例如 *.js 或 src/**/*.ts)。语言或目录特定的规则

AGENTS.md 兼容性

Qoder CN IDE 规则现已兼容 AGENTS.md 文件。要启用此功能:
  1. 只需将 AGENTS.md 文件复制到项目目录中
  2. Agent 将自动识别并利用文件中定义的规则
  3. 无需额外配置 - 集成是无缝的
如果 AGENTS.md 内容与规则内容存在冲突,则规则内容优先。

最佳实践

  • 保持简洁:让规则聚焦且明确无歧义。
  • 结构清晰:使用项目符号、编号列表或 Markdown 格式以提升可读性。
  • 包含示例:提供“良好”的代码示例以指导模型。
  • 迭代与优化:根据模型输出和反馈不断完善规则。

配置规则

  1. 在 Qoder CN IDE 右上角点击用户图标,打开 IDE 设置。也可使用 ⌘ ⇧ ,(macOS)或 Ctrl Shift ,(Windows)。
  2. 在左侧选择规则。
  3. 点击添加,选择项目级规则或用户级规则。创建项目规则前,先打开目标项目。
  4. 输入唯一的规则名称,按 Enter 确认。
  5. 在规则编辑器中选择规则类型,并填写规则内容。
    • 手动引入:在会话中使用 @rule 选择规则。
    • 模型决策:填写适用场景,例如「生成单元测试」。
    • 指定文件生效:填写以逗号分隔的路径通配符,例如 *.md、src/*.java。
    • 始终生效:将规则应用于每次会话和行间会话请求。
  6. 保存规则文件。

后续步骤

要编辑或删除现有规则,请在规则页面选择相应操作。