mimo code 将文档规范转化为可执行、可追踪、可沉淀的开发习惯,通过持久记忆系统自动学习并应用项目文档约定,在代码变更时同步校验、精准定位差异,并自动生成符合风格的文档内容,支持嵌入 ci 流程实现可控守门。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

用 MiMo Code 做代码审查,重点不是“挑错”,而是把文档规范变成可执行、可追踪、可沉淀的开发习惯。它不依赖人工逐条核对 README 或注释格式,而是让 AI 在读代码的同时,同步理解项目约定,并在变更中主动校验和补全。
让 AI 记住你的文档规范
MiMo Code 的持久记忆系统能记住你项目里真实存在的文档模式,比如:哪些文件必须有顶部模块说明、函数注释是否要求 @param/@returns、API 路由变更是否要同步更新 OpenAPI YAML。你不需要写规则配置,只需在首次交互中自然表达:
- “这是我们团队的注释规范,请记住:所有导出函数必须带 JSDoc,参数类型要明确,返回值需标注”
- “README.md 的‘快速开始’章节结构固定为:安装 → 配置 → 启动 → 示例调用”
- “每次修改 src/api/ 目录下的路由文件,都要检查 docs/openapi.yaml 是否已同步更新”
这些指令会被存入 SQLite 记忆库,后续审查时自动激活上下文,无需重复设定。
审查变更时同步校验文档一致性
在 Git 提交前或 PR 创建阶段,直接用 diff 触发审查:
- 单命令触发:git diff main | mimo "检查本次变更是否遗漏文档更新,包括:源码注释、README 片段、OpenAPI 定义"
-
自动识别关联文件:若修改了
src/services/user.ts中的createUser方法,MiMo Code 会主动检索docs/api-reference.md和docs/openapi.yaml中对应条目,比对字段名、参数顺序、状态码描述是否一致 -
差异定位精准:不只说“文档未更新”,而是指出“
docs/api-reference.md第42行缺少对emailVerified字段的说明,与user.ts第87行返回类型不匹配”
自动生成/补全文档内容
发现缺失时,MiMo Code 不止报错,还能按你项目的语言风格和结构生成可用内容:
- 对新增函数,自动补全标准 JSDoc 模板,填入实际参数名和类型(基于 TypeScript 推断)
- 当添加新路由,自动扩写
docs/openapi.yaml,保持 indentation、tags、x-codegen 标记等格式与存量一致 - 更新 README 的“示例调用”区块时,从测试用例中提取真实请求 payload 和响应结构,避免手写失真
生成内容默认以 patch 形式输出,支持一键写入或预览确认,不覆盖原有逻辑。
嵌入 CI 流程做守门人
在 GitHub Actions 或 Jenkins 中加入轻量级检查步骤:
- 运行
mimo --mode review --target diff --rule doc-consistency - 失败时返回具体缺失项(如:“missing JSDoc for exported function ‘validateToken’ in auth.ts”),而非泛泛提示“文档不全”
- 允许临时绕过(
--skip-doc-check),但需填写理由并记录到 PR 评论,确保决策可追溯
这样既守住底线,又不阻碍迭代节奏。











