LegacyDoc AI 是一款运行在 VS Code 中的 AI 代码文档生成器，主要面向遗留项目、AI 生成的应用、快速原型以及继承而来的代码库。它的目标不是让文档变得漂亮，而是让代码库变得可审查、可交接、可清理。
用途
当项目缺少文档、注释和架构说明时，每一次修改都可能带来风险。LegacyDoc AI 帮助开发者在清理、审计或交接代码之前，先为代码生成结构化的文档和上下文材料。它适用于以下场景：
- 为没有 JSDoc、没有 README、变量命名混乱的遗留项目补充文档。
- 为 Claude Code、Cursor、Codex 等 AI 编程代理生成项目上下文包，避免每次会话都重复解释项目背景。
- 在聘请清理专家或使用 AI 重构之前，生成架构说明和模块笔记，帮助评估工作量和风险。
- 在新开发者入职时，提供项目上下文包，替代模糊的 README 和冗长的聊天记录。
- 在审查 AI 生成的代码时，先记录应用的实际路由、组件、服务和数据流，再与预期工作流进行对比。
主要能力
LegacyDoc AI 在 VS Code 内对选定的文件或文件夹执行生成操作，输出内容包括：
- 内联 JSDoc 与注释：在函数上方自动插入 JSDoc，说明参数、返回值、副作用和预期用法，并添加解释性内联注释，同时保留现有代码风格。
- Markdown 文档：生成独立的 .md 文件，包含函数签名、参数说明、用法示例和模块概览，便于交接给团队成员、自由职业者、清理专家或 AI 编程代理。
- Mermaid 架构图：生成展示模块依赖、类层次结构和调用流程的 Mermaid 图表，可直接在侧边栏渲染。
- 项目上下文包：生成可供 AI 编程工具使用的上下文文件，总结项目结构、用途和关键模块，支持 Claude Code、Cursor、Codex 等。
- 清理就绪笔记：识别需要检查的区域、缺失的文档和模块摘要，为清理或重构做准备。
- 多模型 / 自带密钥：使用自己的 API 密钥接入 Claude、GPT、Gemini、Grok 或任意 OpenAI 兼容端点，不产生来自 LegacyDoc AI 的 API 费用。
使用方式
在 VS Code 中使用 LegacyDoc AI 的流程如下：
- 安装与配置：从 VS Code Marketplace 安装扩展，在设置中添加 AI 模型的 API 密钥。
- 选择与生成：右键点击文件或文件夹，选择要生成的内容，例如内联 JSDoc、Markdown 或两者。
- 预览与应用：在侧边栏预览生成的文档，然后选择内联应用或保存为 Markdown 文件。
该工具支持 JavaScript、TypeScript 和 Python 开箱即用，AI 也能处理大多数其他语言，更多一等支持正在开发中。
适用场景
LegacyDoc AI 适合以下人群和场景：
- 需要为遗留代码补充文档的开发者。
- 需要为 AI 编程代理准备项目上下文的独立开发者或团队。
- 在清理、重构或交接前需要生成审计就绪上下文包的项目。
- 需要评估 VS Code 扩展安全性或在敏感仓库中安装 AI 编程工具的用户。
- 需要为 AI 生成的应用进行发布就绪审查的创始人。
- 希望让快速原型代码变得可审查的开发者。
- 在重构前需要生成 Mermaid 图表以理解模块结构的团队。
限制
LegacyDoc AI 有意保持保守，它是一款 AI 代码文档生成器，而不是自动驾驶式重构工具。具体限制包括：
- 它只生成文档、架构图和审计就绪的上下文包，不会重写、重构或修改代码逻辑，不会重命名文件，也不会在未经审查的情况下推送提交。
- 它不执行正式的安全审计，也不保证生产就绪。
- 生成的文档是草稿，需要人工审查假设、边界情况、TODO 和安全注意事项，才能作为可信来源的文档使用。
- 建议先在单个文件夹、功能或模块上运行，聚焦的选择能产生更清晰的文档、更好的图表和更容易审计的上下文包。
- 代码会发送到用户配置的 AI 模型 API（如 Anthropic、OpenAI），不会发送到 RomantiCode 服务器，用户需自行管理 API 密钥。
收费
LegacyDoc AI 提供免费版和 Pro 版：
- 免费版：每天 5 次生成，无需信用卡，支持内联 JSDoc、Markdown、Mermaid，支持 Claude / GPT / Gemini / Grok / 自定义模型，使用自己的 API 密钥。
- Pro 版：一次性支付 29 美元，无订阅。包含无限生成、自定义提示模板、批量文件处理、优先支持，最多可在 3 台设备上激活。购买后许可证密钥通过电子邮件发送，在 VS Code 设置中输入即可解锁。
支付由 Creem 处理。AI API 密钥和代码不经过 RomantiCode 服务器，扩展直接使用用户配置的 AI 提供商。
