【免费下载链接】CodeWiki[ACL 2026] Open-source framework for holistic, structured repository-level documentation across multilingual codebases项目地址https://gitcode.com/gh_mirrors/co/CodeWiki点击查看免费下载CodeWiki 是一个开源的 AI 代码文档生成框架ACL 2026 论文项目它能分析多语言代码仓库的依赖关系自动生成一套结构化的 docs 目录文档包含带Mermaid 架构图的 Markdown 页面、描述模块层级的module_tree.json 模块树以及生成报告 metadata.json。本文带你逐一拆解这些产物新手也能看懂。 先看全景一份文档是怎么长出来的运行一次codewiki generate后CodeWiki 会走完下面这张图里的三个阶段从图中可以看到完整的三步流水线仓库分析与模块分解—— 用 AST/LLM 解析源码构建依赖图Dependency Graph再分解成一棵可管理的模块树Module Tree递归文档生成—— 以模块代码 模块树为输入让 Agent 自底向上为每个模块生成 Markdown 页面含 Mermaid 图层级组装与总览合成—— 子模块文档逐级汇总最终合成整仓的Repo Overview.md。理解了这个流程再看生成的文件就不难了——每个文件都对应流水线的某个环节。 docs 目录全清单生成了哪些文件以本仓库自己的 docs/ 目录为例CodeWiki 用它自己给自己写了文档一次完整生成会产出这几类文件文件作用一句话理解docs/overview.md全仓总览页整棵模块树的首页含架构级 Mermaid 图各模块*.md页面共 30 篇每个模块一页文档如 docs/CLI.md、docs/Python_Analyzer.mddocs/module_tree.json最终模块树模块 ↔ 源码组件 ↔ 文档页的完整映射docs/first_module_tree.json首轮模块树聚类算法第一轮的原始结果用于对比与修复docs/metadata.json生成报告用了什么模型、分析了多少组件、生成了哪些文件docs/temp/dependency_graphs/工作文件依赖图等中间产物非最终交付物docs/index.html静态 HTML 查看器加--github-pages参数时生成可离线浏览全部文档 命名规律每个模块的文档页都以模块名命名例如CLI_Documentation_Generation.md对应模块CLI_Documentation_Generation模块名在整棵树中唯一这就是树节点到文件名的对应规则。 module_tree.json文档的骨架长什么样模块树是整份文档的核心索引。打开 docs/module_tree.json可以看到它是一个嵌套 JSON每个节点包含三类信息Language_Analyzers: { path: codewiki/src/be/dependency_analyzer/analyzers, components: [ codewiki/src/be/dependency_analyzer/analyzers/python.py::PythonASTAnalyzer ], children: { PHP_Analyzer: { ... }, Python_Analyzer: { ... } } }path该模块对应的源码目录路径components模块内的代码组件格式为文件路径::类名/函数名children子模块构成层级树。对照 docs/first_module_tree.json 可以发现首轮树层级较浅最终树module_tree.json中同一模块被进一步细分——这正是 codewiki/src/be/doc_layout.py 里层级式文档布局的基础模块树的形状就是 docs 目录里文档的层级结构。本仓库这份树的统计信息记录在 docs/metadata.json 中statistics: { total_components: 768, leaf_nodes: 62, max_depth: 4 }768 个代码组件被组织成 62 个叶子模块最深层级 4 层——这就是一个大型仓库如何被拆成可读文档的量化答案。 Mermaid 架构图藏在每个 md 页面里CodeWiki 生成的不是纯文字而是带图的文档。以 docs/overview.md 为例它包含两类 Mermaid 图flowchart架构图展示三大入口CLI / Web / MCP如何汇入共享后端管线sequenceDiagram时序图描述提交仓库 → 构建依赖图 → 聚类模块 → 逐模块生成文档的完整流程。每个子模块文档如 docs/CLI.md、docs/Dependency_Analysis_Service.md同样自带 2~8 张 Mermaid 图覆盖架构图、请求流、组件关系等视角。这些图的合法性在生成时经过校验保证浏览器可正常渲染。想看到渲染效果用--github-pages参数生成 docs/index.html 查看器即可——它内嵌模块树与 metadata用 mermaid.js 在浏览器端动态绘图无需任何构建步骤模板源码见 codewiki/templates/github_pages/viewer_template.html。 生成的文档质量如何CodeWiki 2.0 在多语言基准仓库上做过系统评测相比早期版本依赖图组件数最高扩展4.11 倍加权文档质量评分在 7 个真实仓库上平均提升29.47分❓ 新手高频问题Q1生成到哪个目录能改吗默认写入仓库根目录的docs/布局规则由 codewiki/src/be/doc_layout.py 定义支持层级式页面镜像模块树与扁平式两种。Q2代码变更后文档会过时吗用codewiki generate --update做增量更新原理与用法见 guides/incremental-updates.md。Q3支持哪些语言Python、JavaScript/TypeScript、Java、Kotlin、C、C、C#、PHP、Ruby、Scala 等 11 种语言各语言解析器位于 codewiki/src/be/dependency_analyzer/analyzers/。✅ 一句话总结产物回答的问题overview.md 模块 md 页面这个项目是干什么的、各模块怎么工作module_tree.json文档和源码的对应关系是什么Mermaid 架构图系统结构、调用流程长什么样metadata.json这次生成用了什么模型、覆盖了多少代码如果你刚接手一个陌生的大型代码库先用 CodeWiki 跑一遍再打开docs/目录按模块树由上而下阅读会比直接翻源码快得多。更多操作细节可参考 guides/cli-reference.md 与 guides/providers.md。赞分享【免费下载链接】CodeWiki[ACL 2026] Open-source framework for holistic, structured repository-level documentation across multilingual codebases项目地址https://gitcode.com/gh_mirrors/co/CodeWiki点击查看免费下载相关推荐Backstage 架构决策记录解读为什么禁用 React.FC 与 React.SFCADR006Backstage 架构决策记录解读为什么禁用 React.FC 与 React.SFCADR006 本篇技术指南基于 Backstage 仓库中的架构决开发者门户后端前端Mononoke 树形派生数据开发指南为什么优先使用 derive_manifest 构建目录树Mononoke 树形派生数据开发指南为什么优先使用 derive_manifest 构建目录树 本文是 MononokeSapling 开源仓库中的大规模开发工具CLI后端如何一键切换游戏里的 DLSS 版本DLSS Swapper 免费完整指南如何一键切换游戏里的 DLSS 版本DLSS Swapper 免费完整指南 游戏更新附带新版 DLSS 后画面异常、帧率不稳。DLSS Swapper 是一款桌面应用创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考