最佳实践

介绍 DHcoder 的 Prompts 与 Rules 功能最佳实践，帮助你为团队沉淀统一的工程规范与高效协作方式。

Rules（规则）

Rules 的作用

• 明确告知 AI 助手在项目中的行为准则与边界
• 统一团队的代码风格、安全规范与质量标准
• 将组织级最佳实践固化为“护栏”，避免随意性实现
• 让 AI 从通用助手升级为理解项目约束与背景的协作成员

工作方式

• 在聊天窗口上方的工具栏选择“Rules”页签，下拉到最下方，点击 + ADD Rules 按钮创建规则。
• 首次创建会在项目根目录生成（或打开）.dhcoder/rules/ 目录，并自动创建一个规则文件（例如 new-rule.md）。
• 每次点击 + ADD Rules 都会新增一个独立的规则文件（位于 .dhcoder/rules/ 下）。
• 你可以在对应的规则文件（如 .dhcoder/rules/new-rule.md）中书写规则内容，DHcoder 会在 Agent、Chat、Edit 模式下自动识别并遵循这些规则。

推荐结构

# 项目级规则

## 代码风格
- 使用 TypeScript 严格类型；避免 any
- 函数名使用动词或动词短语；变量名使用有意义的全称

## 安全与隐私
- 禁止在日志中输出敏感信息
- 所有外部请求都必须有超时与错误处理

## 架构约束
- 优先使用已有的工具函数与组件
- 模块边界清晰，避免循环依赖

Prompts（提示模板）

Prompts 的作用

• 定义任务/框架相关的交互模式
• 将领域知识沉淀为可复用模板
• 通过一致的提示确保输出质量与团队风格统一
• 可在多个助手或项目之间共享与复用
• 在代码评审等场景中充当自动化检查清单，保证一致性

创建方式

• 在聊天窗口上方的工具栏选择“Prompts”页签，点击 + Add Prompts 按钮创建新的提示模板。
• 新建的模板会保存在 .dhcoder/prompts 目录下，便于版本化与协作。

定义后，你可以在输入框通过 /别名 快速触发，例如 /api-doc、/review 等。

创建方式

• 在聊天窗口上方的工具栏选择“Prompts”页签，点击 + Add Prompts 按钮创建新的提示模板。
• 每次点击都会在 .dhcoder/prompts/ 下新增一个 .yaml 模板文件（例如 new-prompt.yaml）。
• 模板采用 YAML 格式，便于版本化与协作。

示例：在 .dhcoder/prompts 中新增 YAML 模板

name: api-doc
trigger: /api-doc
content: |
  目标：根据接口代码生成简洁规范的 API 文档
  要求：
  - 自动识别请求/响应模型与状态码
  - 使用表格展示字段、类型、必填、说明
  - 给出最小可运行示例

示例：代码评审模板

name: review
trigger: /review
content: |
  角色：资深代码评审
  检查点：
  - 可读性与命名
  - 错误处理与边界条件
  - 性能与资源释放
  - 安全、日志与可观测性
  输出：问题清单 + 建议修复方案

推荐实践清单

• 在 .dhcoder 目录集中管理规则与提示模板，纳入版本控制
• 为每个模板设置明确 name 与 trigger，并在团队内达成共识
• 将规则与模板拆分为小而精的块，避免过长难以维护
• 定期复盘：结合实际使用反馈迭代 Rules 与 Prompts

常见问题

• Rules 不生效？确认 .dhcoder 目录与规则文件已存在，且内容结构正确
• /xxx 无法触发？检查模板的 trigger 是否与输入一致，并确保文件位于 .dhcoder/prompts 下

目录结构示例

.dhcoder/
  rules/
    new-rule.md
  prompts/
    new-prompt.yaml