mimo code 能直接生成结构清晰、内容准确的代码文档，支持自然语言指令触发、多层级输出格式、git 集成自动更新及 /doc 命令快速预览导出。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
MiMo Code 能直接生成结构清晰、内容准确的代码文档，不依赖额外插件或手动整理。它把文档生成当作开发流程的自然延伸，而不是事后补救工作。
用自然语言指令触发文档生成
在终端运行 mimo 进入交互界面后，直接用中文描述需求即可，比如：
- “为 src/utils 目录下所有函数生成 JSDoc 注释，并输出一份 Markdown 格式的模块说明文档”
- “分析整个 backend 服务，生成 API 接口列表、请求参数说明和返回示例”
- “给这个 React 组件加 TypeScript 类型注解，并生成使用说明和 props 表格”
工具会自动识别项目结构、函数签名、调用关系和注释风格，按需补充类型定义、参数说明和典型用法。
支持多层级文档输出格式
它不只生成单个文件的注释，还能按项目维度组织文档体系：
- 内联注释：自动为函数、类、接口插入符合 ESLint / TSDoc 规范的注释块
- 模块级 README.md：汇总目录功能、导出项、依赖说明和快速上手示例
- API 参考手册：提取 Express/Koa 路由或 FastAPI 端点，生成带 curl 示例的表格文档
- 架构图描述文本：基于 import/export 关系，生成文字版模块依赖拓扑说明
结合 Git 和上下文持续更新
文档不是一次性产物，而是随代码演进自动维护：
- 每次执行 git commit 后，可配置自动触发文档同步（通过
mimo git-hook enable） - 修改函数逻辑后，再次运行文档指令，它会比对旧注释，只更新变更部分，保留人工编辑痕迹
- 跨会话记忆能记住你偏好的文档粒度（如是否包含错误码、是否生成测试用例片段）
用 /doc 命令快速预览与导出
在 TUI 或 Web 界面中，输入快捷命令即可操作：
-
/doc --scope=src/api --format=markdown：生成指定路径的 Markdown 文档 -
/doc --preview：弹出实时渲染的 HTML 预览页（Web 模式下） -
/doc --export=docs/：将全部文档导出到本地 docs/ 目录，含索引导航
生成的文档默认包含版本标识、最后更新时间戳和源码链接锚点，方便团队协作查阅。
