7603a7561a
♻️ refactor(agent): 拆分 agentsvc，并增强 quicknote/outbox 注释与可维护性 - 📦 将 Agent 服务实现从 `service` 根目录迁移到 `service/agentsvc`，包含 `agent.go`、`agent_quick_note.go` 及相关测试 - 🔌 新增 service 层兼容桥接 `agent_bridge.go`，保持 `service.NewAgentService` 与 `*service.AgentService` 现有调用方式不变 - 📝 为 `quicknote` 补充高密度中文步骤化注释，覆盖 `graph` / `runner` / `nodes` / `tool` / `state` / `prompt`，明确职责边界、分支条件、重试与兜底策略 - 🧭 为 `infra/outbox` 与 service agent 链路补充详细中文注释，覆盖状态机流转、幂等处理、失败回写与异步持久化语义 - ✅ 统一格式化相关文件，并通过全量后端测试：`go test ./...` 📝 chore(docs): 更新 AGENTS.md 注释强制规范 - 📚 追加“注释规范（强制）”与“注释风格示例” - ✍️ 明确复杂逻辑必须使用步骤化注释、跨文件调用需写调用目的、注释需同步维护
37 lines
1.6 KiB
Markdown
37 lines
1.6 KiB
Markdown
# AGENTS.md
|
||
|
||
## 协作偏好（逐条追加）
|
||
|
||
1. 默认语言规则：所有注释、接口文案、说明、评审反馈均使用中文。
|
||
2. 请勤加注释，尤其是复杂逻辑部分，确保代码易于理解和维护。
|
||
|
||
## 注释规范（强制）
|
||
|
||
1. 默认使用中文注释，禁止英文注释（专业术语除外）。
|
||
2. 复杂逻辑必须写“步骤化注释”，用 `1. / 2. / 2.1` 这种编号，说明：
|
||
- 这一步要做什么
|
||
- 为什么要这样做
|
||
- 失败时怎么处理
|
||
- 兜底/回退策略是什么
|
||
3. 函数注释至少说明“职责边界”：
|
||
- 这个函数负责什么
|
||
- 不负责什么
|
||
- 输入输出语义（尤其是 bool、error、状态字段）
|
||
4. 涉及分支、重试、事务、幂等、并发、状态机的代码，必须写清楚判断依据与流转条件。
|
||
5. 跨文件调用前必须写“调用目的注释”，让读者不跳转文件也能理解当前代码意图。
|
||
6. 注释禁止空话（如“设置变量”“调用方法”）；必须写业务意图与约束。
|
||
7. 改动代码时，如修改了复杂逻辑，必须同步更新注释；注释过期视为不合格提交。
|
||
8. 不要求每行都注释；简单直白代码可省略，重点保证关键路径可读性。
|
||
|
||
## 注释风格示例
|
||
|
||
推荐：
|
||
- `// 1. 先查缓存，命中则避免回源 DB，降低接口延迟。`
|
||
- `// 2. 缓存未命中再查库；若查库失败直接返回，避免写入不完整状态。`
|
||
- `// 3. 写库成功后再更新缓存，保证“先真后快”，避免脏缓存。`
|
||
|
||
不推荐：
|
||
- `// 查询缓存`
|
||
- `// 调用 DAO`
|
||
- `// 返回结果`
|