AI 助手
TRAE 智能问答助手
你好,我是 TRAE 文档问答助手 🎉 你在阅读当前文档的过程中,无论对文档概念的解释,还是文档内容方面的疑问,都可以随时向我提问,我会全力为你解答
推荐问题
TRAE IDE 里最热门的 Skill 是哪些?
如何创建自定义智能体?
如何配置 Rules?
文档反馈
入门
最佳实践
协作方式
Agent 配置
Design 模式
任务执行
网页与电脑操作
产物管理
外部应用授权
内置资源
开发环境
系统设置
官方活动
相关协议

规则(Rules)

复制页面

你可以通过制定规则来规范 AI 在 TraeWork 内的行为,包括代码风格、语言与框架、交互方式等,使 AI 的输出更符合你的个人偏好和项目要求。

了解规则

应用场景

规则的主要应用场景如下:

  • 提升效率
    将个人经验和项目要求转化为可复用的规则,一次配置可长期生效,减少与 AI 的沟通成本以及人工审校时间。
  • 统一标准
    将团队规范、项目标准结构化为规则,使所有成员所负责的内容在风格、结构和质量上保持一致,避免偏差。
  • 保障质量
    让 AI 明确项目的核心约束(架构设计、命名规范、代码风格等),避免常见错误。

规则类型

你可以配置两类规则:全局规则、项目规则。

  • 全局规则:全局规则是基于个人使用习惯和需求为 AI 定制的规则,旨在让 AI 的输出更符合用户的个性化要求。全局规则在所有项目中生效。
  • 项目规则:项目规则是针对当前项目 AI 需要遵循的规则,仅在所配置的项目中生效。

规则所在目录

  • 全局规则
    • macOS/Linux:本地根目录 ~/.trae-cn/user_rules
    • Windows:本地根目录 %userprofile%/.trae-cn/user_rules
  • 项目规则:项目所在路径下的 .trae/rules/ 目录。

规则的运行环境

环境类型 适用任务 适用客户端
本地 仅对本地任务生效。 TraeWork 桌面版
云端 仅对云端任务(及从 GitHub 拉取的项目)生效。 TraeWork 网页版、桌面版

创建全局规则

根据实际需求,创建一条或多条全局规则。步骤如下:

  1. 在界面左下角,点击 头像 > 设置,进入设置中心。
  2. 在左侧导航栏中,选择 规则
    你将进入规则管理面板。
  3. (仅 TraeWork 桌面版) 选择技能所运行的环境:本地 / 云端
  4. 点击 创建 按钮。
  5. 在输入框中输入你的规则。
  6. 点击 保存 按钮。
    Image

创建项目规则

方式一:手动创建规则

在目标项目的 .trae/rules/ 目录下,创建 Markdown 格式的文件,然后在文件中写入你希望 AI 遵守的规则并保存。

方式二:导入外部规则

除了 TraeWork 原生的项目规则,你还可以复用以下两类位于项目根目录的规则文件,它们均为项目级规则,仅在当前项目中生效:

  • AGENTS.md:面向 AI 的项目规则文件,用直观、易读的文本描述项目内需遵守的指令和规范。它是跨工具的通用规范,在 TraeWork 中创建的 AGENTS.md 可在其他支持该规范的 IDE 中复用,反之亦然。
  • CLAUDE.mdCLAUDE.local.md:Claude Code 的项目规则文件。TraeWork 与其兼容,从 Claude Code 迁移项目到 TraeWork 时,这些文件会随项目一并导入。

提示

仅 TraeWork 桌面版支持 AGENTS.mdCLAUDE.mdCLAUDE.local.md

若要让 AGENTS.mdCLAUDE.mdCLAUDE.local.md 文件在 TraeWork 中生效,使用以下步骤:

  1. 确认规则文件位于项目根目录:
    • AGENTS.md 需手动放置在项目根目录下;
    • CLAUDE.mdCLAUDE.local.md 在项目迁移时会自动带入。
  2. 前往 设置 > 规则
  3. 在 导入设置 处,打开 AGENTS.md 包含在上下文中 CLAUDE.md 包含在上下文中 开关。
    Image

最佳实践

  • 控制单条规则的内容粒度,避免在一条规则中包含过多信息,使其保持清晰、聚焦、易于理解。
  • 各条规则之间不得彼此冲突或相互覆盖。
  • 在指定文件路径时,使用相对于项目根目录的相对路径,以确保 AI 能准确定位文件。
  • 引用规则时,优先选择与当前对话或任务强相关的规则。
  • 新建或修改规则后,建议开启全新的对话再使用,以避免历史上下文与新规则产生冲突。
  • 若项目中已有大量不符合规范的代码,模型可能会沿用现有代码风格而非遵循新规则。此时建议:
    • 明确向模型说明当前任务为“重构”;
    • 在特定场景中强制要求 AI 严格遵循新规则;
    • 启动专门的重构项目,逐步提升整体代码质量。

示例

  • 所有回答都使用中文表述。
  • 如需提供代码,为关键逻辑和可能造成理解困难的部分添加简明的中文注释。
  • 当生成的代码超过 20 行时,优先考虑是否可以进行适当的抽象或聚合。
  • 避免不必要的对象复制或克隆。
  • 避免多层嵌套,提前返回。
  • 使用适当的并发控制机制。
  1. 小步重构:
    • 每次只做一个小改动,然后测试。
    • 频繁提交,保持代码随时可工作。
  2. 测试保障:
    • 重构前确保有足够的测试。
    • 每次修改后运行测试,确保行为不变。
  3. 代码审查:
    • 重构后进行代码审查,确保质量。
  1. 命名约定:
    • 使用有意义的、描述性的名称。
    • 遵循项目或语言的命名规范。
    • 避免缩写和单字母变量(除非是约定俗成的,如循环中的 i)。
  2. 代码组织:
    • 相关代码放在一起。
    • 函数只做一件事。
    • 保持适当的抽象层次。
  3. 注释与文档:
    • 注释应该解释为什么,而不是做什么。
    • 为公共 API 提供清晰的文档。
    • 更新注释以反映代码变化。
  1. 内存优化:
    • 避免不必要的对象创建。
    • 及时释放不再需要的资源。
    • 注意内存泄漏问题。
  2. 计算优化:
    • 避免重复计算。
    • 使用适当的数据结构和算法。
    • 延迟计算直到必要时。
  3. 并行优化:
    • 识别可并行化的任务。
    • 避免不必要的同步。
    • 注意线程安全问题。