FSoft-AI4Code/CodeWiki

它解决了什么问题

CodeWiki 自动化创建大型代码库的全面仓库级文档。它消除了手动编写架构概览和模块描述的工作，尤其是针对跨数千至数百万行代码、涵盖多种编程语言的项目。

工作原理

该工具分析仓库以构建依赖图，然后将其拆分为模块的层次树。AI 代理以递归方式部署：叶模块代理根据代码编写各个页面，而父模块代理将这些子页面综合成更高级别的概览。它还将 Dockerfile 和 CI 工作流等非代码工件纳入图中，以记录构建和部署过程。系统支持增量更新，使其在代码更改后仅修补受影响的模块，而无需重新生成整个文档集。

适用对象

大型项目的软件工程师、架构师和维护者，他们需要最新且高级别的文档，而不想手动维护。

亮点

• 多语言支持：支持 11 种语言，包括 Python、Java、C++、Rust 和 TypeScript。
• 层次分解：通过将依赖图聚类成可管理的模块树，扩展到百万行代码的仓库。
• 感知工件：记录构建文件、包清单和配置模式，同时涵盖代码。
• 增量更新：仅更新受特定代码提交影响的页面，以降低成本和时间。
• IDE 集成：提供 MCP 服务器，可与 Cursor 或 Claude Desktop 等 AI IDE 配合使用。
• 多语言输出：能以多种语言（例如日语、越南语）生成文档。