docs: 为全部 38 个源文件补充详细模块级注释
为 iAs 项目的所有 Rust 源文件添加了系统化的模块级文档注释(//!), 覆盖全部 src/ 下的文件。每个文件包含模块职责、架构设计、数据流 和关键设计决策的说明。 主要变更: - 入口/CLI: main.rs, cli.rs — 系统架构概览、子命令说明 - Daemon/Worker: daemon.rs, worker.rs — 三消费者架构、旧架构说明 - 微信通道: mod.rs, client.rs, types.rs — API 端点、登录流程 - LLM 系统: mod.rs, types.rs, provider.rs, deepseek.rs, conversation.rs — 架构分层、流式处理、工具循环、摘要机制 - 上下文管理: mod.rs, types.rs, builder.rs, tools.rs — Checkpoint 机制、Token Budget、双重摘要 - 工具系统: mod.rs, types.rs, builtin.rs, approval.rs — 两层元工具架构、审批流程 - 内置工具: mod.rs + 6 个工具 — API 端点、认证方式、参数说明 - 消息队列: mod.rs, message_queue.rs, runner.rs — 公平轮转算法、三消费者路由 - 数据库/状态/调度/日志: db/mod.rs, state.rs, scheduler.rs, logger.rs — 表结构、回退策略、定时任务、日志初始化
This commit is contained in:
@@ -9,6 +9,26 @@
|
||||
//! 数据库是可选的。如果数据库不可用,系统会优雅地回退到文件存储
|
||||
//! (`StateManager`),核心功能仍然可用。
|
||||
|
||||
//! ## 数据库管理 —— PostgreSQL 连接 + 迁移
|
||||
//!
|
||||
//! ### 职责
|
||||
//! 1. 从 `DATABASE_URL` 环境变量连接 PostgreSQL
|
||||
//! 2. 自动运行 `./migrations/` 下的 SQL 迁移
|
||||
//! 3. 提供连接池引用给各模块使用
|
||||
//!
|
||||
//! ### 回退策略
|
||||
//! 数据库是可选的。如果数据库不可用,系统会优雅地回退到文件存储
|
||||
//! (`StateManager`),核心功能仍然可用。
|
||||
//!
|
||||
//! ### 表结构
|
||||
//! - `app_state` — 认证状态 KV 存储
|
||||
//! - `chat_records` — 收发消息记录
|
||||
//! - `llm_usage` — Token 用量统计
|
||||
//! - `user_memories` — 用户长期记忆
|
||||
//! - `pending_approvals` — 待审批记录
|
||||
//! - `session_summaries` — 会话摘要
|
||||
//! - `scheduled_tasks` — 定时任务
|
||||
|
||||
pub mod models;
|
||||
|
||||
use sqlx::postgres::PgPoolOptions;
|
||||
|
||||
Reference in New Issue
Block a user