使用适用于Visual Studio Code的 Office 外接程序开发工具包创建 Office 外接程序项目

Office 外接程序开发工具包有助于设置环境、创建 Office 加载项，以及通过简化的体验调试代码。

重要

Office 外接程序开发工具包扩展仅支持创建使用 仅加载项清单的加载项。 此时，它还仅创建 Excel、PowerPoint 和Word加载项。 正在开发对 Outlook 的支持，以及其他示例和其他改进。 我们欢迎你对该工具的任何反馈。 应通过 扩展存储库上的 GitHub 问题提交问题和功能请求。

先决条件

• 下载并安装 Visual Studio Code。
• Node.js（最新LTS 版本）。 访问 Node.js 站点 ，下载并安装适合你的操作系统的版本。 若要验证是否已安装这些工具，请在终端中运行 命令 node -v 和 npm -v 。
• 连接到 Microsoft 365 订阅的 Office。 你可能有资格通过 Microsoft 365 开发人员计划获得Microsoft 365 E5开发人员订阅，有关详细信息，请参阅常见问题解答。 或者，可以 注册 1 个月的免费试用版 或 购买 Microsoft 365 计划。

安装开发工具包

可以使用 Visual Studio Code 中的扩展安装 Office 外接程序开发工具包，也可以从 Visual Studio Code 市场安装它。

Visual Studio Code

1. 启动Visual Studio Code。
2. 选择 “视图>扩展 ”或 “Ctrl+Shift+X”。 还可以通过从Visual Studio Code活动栏中选择“扩展”选项卡来打开扩展。
3. 在搜索框中输入 Office 加载项开发工具包 。
4. 选择 “Office 加载项开发工具包”。 在“main”窗格中显示的“Office 加载项开发工具包扩展”页中，选择“安装”。 成功安装后，Office 外接程序开发工具包图标将显示在Visual Studio Code活动栏中。

市场

1. 在 Visual Studio Code 市场中打开 Office 加载项开发工具包页。
2. 在网页上选择“ 安装 ”。 如果系统提示扩展需要Visual Studio Code，请选择“继续”。
3. 浏览器可能会要求你验证站点是否正在尝试打开Visual Studio Code。 允许打开Visual Studio Code。 然后，Visual Studio Code将打开并显示 Office 加载项开发工具包扩展自述文件。
4. 选择“在Visual Studio Code中安装”。 成功安装后，Office 外接程序开发工具包图标将显示在Visual Studio Code活动栏中。

创建加载项项目

Office 外接程序开发工具包提供了两种开始使用新项目的方法：模板和示例。 模板允许你选择 Office 应用程序、编程语言和启动功能。 示例是演示现实方案的更完整的项目。

从模板创建加载项

模板为加载项提供了一个基本起点。 它们添加了最少的功能，因此无需更改大部分现有代码即可开始使用。 以下说明介绍如何使用开发工具包从模板创建新项目。

1. 打开Visual Studio Code并选择活动栏中的 Office 外接程序开发工具包图标。
2. 在扩展任务窗格中 选择“创建新外接程序 ”。
3. 在“当前处于活动状态的快速选取”菜单中，选择加载项的 Office 应用程序。
4. 从可用模板列表中选择加载项模板。
5. 选择“JavaScript”或“TypeScript”作为编程语言。
6. 在打开的 “工作区文件夹 ”对话框中，选择要在其中创建项目的文件夹。
7. 提示时，为项目 (指定一个名称，) 没有空格。 Office 外接程序开发工具包将使用基本文件和基架创建项目。 然后在第二个Visual Studio Code窗口中打开项目。 可以自由关闭原始Visual Studio Code窗口。

从示例创建加载项

示例显示了一个可解决端到端方案的工作加载项。 示例作为学习工具最有用，可用于了解 Office 外接程序框架的功能如何协同工作。 还可以扩展示例以满足特定需求。

1. 打开Visual Studio Code并选择活动栏中的 Office 外接程序开发工具包图标。
2. 选择“ 查看示例”。
3. 选择要查看的示例。
4. 选择现在打开的示例自述文件上方的“ 创建 ”按钮。
5. 在打开的 “工作区文件夹 ”对话框中，选择要在其中创建项目的文件夹。 扩展将示例的某个版本复制到该文件夹。 然后在第二个Visual Studio Code窗口中打开项目。 可以自由关闭原始Visual Studio Code窗口。

测试加载项

若要了解外接程序如何在 Office 应用程序中工作，请使用 Office 外接程序开发工具包在本地开发环境中运行和调试 Office 加载项。

注意

这些步骤与创建新项目时扩展Visual Studio Code中列出的步骤相同。

1. 通过选择 活动栏中的 Office 加载项开发工具包图标打开扩展。
2. 选择 “预览 Office 加载项 (F5)
3. 在“快速选取”菜单中，选择“{Office Application} 桌面 (Edge Chromium) ”选项，其中“{Office Application}”是相应的应用程序，例如“Excel”或“Word”。 这将启动加载项并调试代码。

开发工具包在调试开始前检查是否满足先决条件。 如果环境出现问题，请检查终端以获取详细信息。 完成此过程后，Office 桌面应用程序将启动并旁加载加载项。 请注意，首次运行项目时，安装依赖项可能需要几分钟时间。 出现提示时，需要安装证书。

停止测试 Office 加载项

完成加载项测试和调试后， 请始终 按照以下步骤关闭加载项。 (关闭 Office 应用程序或 Web 服务器窗口不会可靠地取消注册加载项.)

1. 通过选择 活动栏中的 Office 加载项开发工具包图标打开扩展。
2. 选择“ 停止预览 Office 加载项”。 这会关闭 Web 服务器，并从注册表和缓存中删除加载项。
3. 关闭 Office 应用程序窗口。

疑难解答

如果在运行加载项时遇到问题，请执行以下步骤。

• 关闭任何打开的 Office 实例。
• 使用“ 停止预览 Office 加载项 Office 外接程序开发工具包扩展”选项关闭加载项的上一个 Web 服务器。

排查 Office 加载项的开发错误一文包含常见问题的解决方案。 如果仍然遇到问题， 请创建 GitHub 问题 ，我们将为你提供帮助。

有关在 Office web 版 上运行加载项的信息，请参阅将 Office 加载项旁加载到Office web 版。

有关在旧版 Office 上进行调试的信息，请参阅使用 Microsoft Edge 旧版 中的开发人员工具调试加载项。