WilliamSmithEdward/xlide_vscode

# XLIDE：适用于 VS Code 的 VBA XLIDE 为 Excel VBA 项目提供了一个现代化的 VS Code 工作区。 将一个或多个 `.xlsm`、`.xlsb` 或 `.xlam` 工作簿添加到您的 VS Code 项目中， XLIDE 会自动检测它们。在 XLIDE 树状视图中浏览每个工作簿的 VBA 项目，直接 从工作簿中打开模块，使用具备工作簿感知能力的 IntelliSense 进行编辑， 并通过常规的 VS Code 保存行为将更改保存回工作簿。当您需要基于文件的工作流时， 可以对选定的工作簿使用完整的本地磁盘推/拉工作流：预览详细的 并排差异，将工作簿模块导出为 `.bas` 和 `.cls` 文件，将它们 提交到您最喜欢的版本控制平台，并将审查过的文件重新导入 到该工作簿中。 对于新手程序员，XLIDE 让 VBA 语言变得更容易上手。 它会显示有用的补全列表，解释符号，突出显示可能的错误， 并在您学习 Excel 自动化原理时保持工作簿的项目结构可见。 对于经验丰富的 VBA 开发者，XLIDE 为现有的 工作簿带来了严肃的工程化工作流：项目级符号导航、重命名和引用工具、 完整的静态分析、实时诊断、工作簿级分析报告、 模块限定的 IntelliSense、导入/导出差异预览、对源代码控制友好的 `.bas`/`.cls` 同步、显式的工作簿设置、性能 诊断，以及当您需要运行时信心时可以通过 Excel 执行的工作簿单元测试。 对于所有人来说，XLIDE 为 Excel 开启了全新的 Agentic AI 界面。兼容的 AI 助手可以检查真实的工作簿、读写 VBA 模块、分析 代码、运行测试、检查工作表数据，并通过 显式的 XLIDE 工具与文件同步模块。这意味着 AI 助手可以直接处理工作簿本身，而 不仅仅是复制的片段或过期的导出文件，从而使 Excel 自动化更具可审查性、 可测试性和协作性。 [从 Visual Studio Marketplace 安装 XLIDE](https://marketplace.visualstudio.com/items?itemName=WilliamSmithE.xlide) ## 为什么要使用 XLIDE 1. **让 VBA 更易于学习和维护** VBA 功能强大，但其规则、项目结构和 Excel 对象模型可能 让人感到隐蔽。XLIDE 通过工作簿导航、 IntelliSense、悬停解释、签名帮助、语义着色和 您在输入时的即时反馈，让它们变得清晰可见。 2. **更早地发现 VBA 错误** 对于许多高置信度的 VBA 问题，XLIDE 会显示实时的红色和黄色波浪线： 缺少块闭合符、名称重复、未声明的变量、 无效的参数/属性结构、数组误用、错误的 `Set` 用法、常见的 `#If` 陷阱等等。 3. **获取了解您工作簿的 IntelliSense** 补全功能和工具提示了解您的模块、类、函数、 常量、枚举、用户定义类型、XML 文档注释，以及大量 Excel 对象模型成员。 4. **在真正的代码编辑器中编辑工作簿 VBA** 在 VS Code 中使用常规的编辑器习惯处理工作簿模块：标签页、 搜索、保存、重命名、转到定义、查找所有引用、悬停、 签名帮助、对格式化友好的缩进以及语义着色。 5. **保持工作簿代码的可审查性** 将模块导出为 `.bas` 和 `.cls` 文件，准确预览将要发生的更改， 并使用源代码管理工作流，而无需猜测二进制 工作簿内部的内容。 6. **安全地导入和导出** XLIDE 在应用 创建、更新、覆盖和删除操作之前会进行预览。特定于工作簿的设置位于工作簿旁边， 因此每个项目都可以保留自己的同步规则。 7. **分析整个工作簿** 运行全面的工作簿分析，并在专门的报告中查看结果，而不是 一个接一个地在模块中寻找。 8. **在 Excel 可用时运行宏和工作簿测试** 在安装了 Microsoft Excel 的 Windows 上，XLIDE 可以通过 显式的 Excel 自动化运行宏和 `@xlide-test` 工作簿测试。 9. **为 AI 助手提供真实的工作簿上下文** XLIDE 公开了用于工作簿发现、VBA 读写、分析、 测试、工作表/单元格访问、公式和模块同步的工具，以便 Agent 可以基于 实际的工作簿工作，而不是基于过期的导出文件。 ## 适用人群 如果您属于以下情况，XLIDE 会非常有用： - 正在为课程、实习、第一个自动化项目或职业转型 学习 VBA。 - 大量使用 Excel，并希望在不忽略 工作簿的情况下开始编程。 - 是学生、分析师、会计师、工程师、研究人员或运营人员， 希望将重复的电子表格工作转化为可重用的自动化。 - 拥有包含 VBA 的业务关键型 Excel 工作簿。 - 维护用于财务、运营、报告、工程或 内部工具的共享宏。 - 希望在更改旧的 VBA 项目之前更好地了解它们。 - 需要与团队成员一起审查工作簿代码。 - 偏好 VS Code 的编辑、搜索、导航和源代码控制。 - 希望获得可以直接检查工作簿的 AI 帮助。 Excel 仍然是运行工作簿的地方。XLIDE 在 VBA 项目周围添加了一个更好的工作区。 ## 快速入门 1. 安装扩展： [Visual Studio Marketplace 上的 XLIDE](https://marketplace.visualstudio.com/items?itemName=WilliamSmithE.xlide) 2. 如果您还没有安装 Python 3.10 或更高版本，请安装它： [下载 Python](https://www.python.org/downloads/) 3. 在 VS Code 中打开一个包含 `.xlsm`、`.xlsb` 或 `.xlam` 工作簿的文件夹。 4. 在活动栏中打开 XLIDE 视图。如果设置未完成，请使用 侧边栏按钮选择 Python 并安装所需的 Python 库。 5. 展开您的工作簿，打开一个模块，然后开始编辑。按下 `Ctrl+S` 将代码保存回工作簿。 从此处开始获取引导式入门指南： [开始使用 XLIDE](https://github.com/WilliamSmithEdward/xlide_vscode/blob/main/user_guides/getting_started.md) ## 日常工作流 ### 编辑 VBA 模块 在 XLIDE 树状视图中打开工作簿，选择一个模块，在 VS Code 中进行编辑并保存。 XLIDE 会将该模块写回工作簿。 ### 修复红色波浪线 您在输入时会出现实时诊断。要进行更全面的检查，请从工作簿菜单中运行 **XLIDE: Analyze Workbook** 并查看分析报告。 指南： [分析与忽略](https://github.com/WilliamSmithEdward/xlide_vscode/blob/main/user_guides/analysis.md) ### 与文件同步代码 使用 **Export Modules to Folder** 创建或更新 `.bas` 和 `.cls` 文件。 使用 **Import Modules from Folder** 将审查过的文件重新带入 选定的工作簿。XLIDE 在应用 更改之前会显示工作簿范围的预览。 指南： [导入和导出](https://github.com/WilliamSmithEdward/xlide_vscode/blob/main/user_guides/sync.md) ### 运行测试 将 VBA 过程标记为工作簿测试，然后从 XLIDE 运行它们。测试执行 需要 Windows 上的 Microsoft Excel。 指南： [测试 VBA 工作簿](https://github.com/WilliamSmithEdward/xlide_vscode/blob/main/user_guides/testing.md) ### 安全地使用 AI 助手 XLIDE 为兼容的 VS Code AI Agent 提供了检查和编辑工作簿 VBA、 运行分析、导出模块以及读取工作表数据的工具，并具备明确的 工作簿上下文。 指南： [自动化与 CI](https://github.com/WilliamSmithEdward/xlide_vscode/blob/main/user_guides/automation.md) ## XLIDE 为 VS Code 增加了什么 - 用于 `.xlsm`、`.xlsb` 和 `.xlam` 文件的工作簿和模块树。 - 由工作簿支持的可写 VBA 编辑器。 - VBA 语法高亮和语义着色。 - 针对工作簿符号、VBA 语言功能和 Excel 宿主 对象的 IntelliSense。 - 悬停、签名帮助、转到定义、查找所有引用和重命名 符号。 - 用于常见 VBA 结构的智能回车和块代码片段。 - 实时诊断和全面的工作簿分析。 - 特定于工作簿的分析跟踪和规则控制。 - 可预览的模块导入/导出。 - 在装有 Excel 的 Windows 上执行宏和工作簿测试。 - 用于故障排除的支持包和诊断命令。 - 用于调试缓慢工作流的可选性能快照命令。 ## 环境要求 常规浏览、编辑、分析、导入和导出所需： - Visual Studio Code 1.95 或更高版本。 - Python 3.10 或更高版本。 - 由 XLIDE 设置安装的 Python 包：`pyOpenVBA` 和 `openpyxl`。 仅在从 XLIDE 运行 VBA 代码时需要： - Windows。 - Microsoft Excel。 - 允许代码运行的工作簿宏设置。 读取、编辑、分析、导入和导出工作簿 VBA 不需要 Excel 自动化。 设置和恢复指南： [安全、信任与支持](https://github.com/WilliamSmithEdward/xlide_vscode/blob/main/user_guides/support.md) ## 用户指南 | 需求 | 指南 | |---|---| | 首次设置和第一个工作簿工作流 | [开始使用](https://github.com/WilliamSmithEdward/xlide_vscode/blob/main/user_guides/getting_started.md) | | 诊断、分析结果和忽略的发现 | [分析与忽略](https://github.com/WilliamSmithEdward/xlide_vscode/blob/main/user_guides/analysis.md) | | 导入/导出和模块同步 | [导入和导出](https://github.com/WilliamSmithEdward/xlide_vscode/blob/main/user_guides/sync.md) | | 编写和运行工作簿测试 | [测试 VBA 工作簿](https://github.com/WilliamSmithEdward/xlide_vscode/blob/main/user_guides/testing.md) | | 用于 IntelliSense 的 XML 文档注释 | [VBA 文档注释](https://github.com/WilliamSmithEdward/xlide_vscode/blob/main/user_guides/vba-doc-comments.md) | | AI Agent 和 CI 工作流 | [自动化与 CI](https://github.com/WilliamSmithEdward/xlide_vscode/blob/main/user_guides/automation.md) | | 信任模型、Excel 设置、支持包和恢复 | [安全、信任与支持](https://github.com/WilliamSmithEdward/xlide_vscode/blob/main/user_guides/support.md) | | 完整指南索引 | [用户指南 README](https://github.com/WilliamSmithEdward/xlide_vscode/blob/main/user_guides/README.md) | ## 常用命令 打开命令面板并输入 `XLIDE` 以查找这些命令： | 命令 | 使用场景 | |---|---| | `XLIDE: Analyze Workbook` | 在一个报告中查看整个工作簿的问题。 | | `XLIDE: Analyze Current Module` | 仅检查您正在编辑的模块。 | | `XLIDE: Export All Modules to Folder` | 将工作簿代码保存为可审查的源文件。 | | `XLIDE: Import Modules from Folder` | 将审查过的模块文件重新带入工作簿。 | | `XLIDE: Unit Tests` | 通过 Excel 运行标记的工作簿测试。 | | `XLIDE: Open Workbook in Excel` | 在 Excel 中打开选定的工作簿。 | | `XLIDE: Copy Diagnostics` | 复制设置和环境详细信息以获取支持。 | | `XLIDE: Export Support Bundle` | 创建故障排除包。 | | `XLIDE: Copy Performance Snapshot` | 当感觉某些操作缓慢时，复制最近的计时数据。 | ## 注意事项与限制 - XLIDE 通过工作簿文件读取和写入 VBA 模块。对于重要的 工作簿，请保留常规备份，尤其是在进行大型同步操作之前。 - 运行宏或测试使用 Excel 自动化，并且仅限 Windows。 - UserForm 设计器文件不能直接编辑。在受支持的情况下，XLIDE 可以处理 VBA 隐藏代码。 - Live Share 访客可以查看和编辑宿主已经打开的模块，但 只有宿主可以浏览 XLIDE 工作簿树。 - 导出的 `.bas` 和 `.cls` 文件对于审查和源代码控制很有用，但 除非您明确将文件重新导入其中，否则工作簿 仍然是唯一事实来源。 ## 支持开源 XLIDE 是开源软件。如果它节省了您的时间或帮助您的团队保持 VBA 工作簿的可维护性，您的支持有助于推动项目向前发展。 - [GitHub Sponsors](https://github.com/sponsors/WilliamSmithEdward) - [PayPal](https://www.paypal.com/donate/?business=ML855BRLNR838&no_recurring=0&item_name=VBA+has+always+treated+me+well.+It+was+how+I+first+grew+professional+as+a+programmer%2C+I%27m+happy+to+show+it+some+love+%E2%9D%A4%EF%B8%8F¤cy_code=USD) - [Cash App](https://cash.app/$williamesmithjcil)

标签：AI辅助编程, Excel, SOC Prime, VBA, 云安全监控, 代码编辑器, 开发工具, 自动化攻击, 逆向工具, 静态分析