调试 Office 加载项概述

调试 Office 加载项实质上与调试任何 Web 应用程序相同。 但是，一组工具不适用于所有加载项开发人员。 这是因为加载项可以在不同的操作系统上开发并跨平台运行。 本文可帮助你找到开发环境的详细调试指南。

提示

本文关注的是狭义上的调试，即设置断点和单步执行代码。 有关测试和故障排除的指南，请从 测试 Office 加载项 和 使用 Office 加载项排查开发错误 开始。

注意

尽管应在要支持的所有平台上 测试 加载项，但在不同于开发计算机的环境中，你只需要进行 调试。 因此，本文使用“开发计算机”和“你的开发环境”来表示要进行调试的环境。 如果代码中的问题仅发生在开发计算机以外的平台上，并且需要设置断点或单步执行代码来解决该问题，则进行调试的环境并不是你的开发环境。

服务器端还是客户端？

调试 Office 加载项的服务器端代码与调试任何 Web 应用程序的服务器端相同。 请参阅 IDE 或其他工具的调试说明。 下面是一些最常用工具的示例。

• 在 Visual Studio 中调试 ASP.NET 或 ASP.NET Core 应用
• 调试 Express
• Node.js 调试指南
• VS Code 中的 Node.js 调试
• Webpack 调试

本文的其余部分仅涉及调试客户端 JavaScript（可从 TypeScript 转译）。

特殊情况

在某些特殊情况下，对于给定的平台、Office 应用程序和开发环境组合，调试过程不同于正常情况。 如果要调试这些特殊情况中的任何一种，请使用本部分中的链接来查找适当的指南。 否则，请继续使用 常规指南。

• 调试 Office.initialize 或 Office.onReady 函数：调试 initialize 和 onReady 函数。
• 在 非共享 运行时中调试 Excel 自定义函数：非共享运行时中的自定义函数调试。
• 在 非共享 运行时中调试 函数命令：
  • Windows 开发计算机上的 Outlook 加载项：在 Outlook 加载项中调试函数命令
  • Mac 开发计算机上的其他 Office 应用程序加载项或 Outlook：使用非共享运行时调试函数命令。
• 调试基于事件的或垃圾邮件报告的 Outlook 加载项： 调试基于事件的加载项和垃圾邮件报告加载项。
• 在新的 Outlook on Windows 桌面客户端中调试外接程序 (预览版) ：请参阅 为新的 Outlook on Windows 开发 Outlook 加载项的“调试加载项”部分。
• 调试基于 Blazor 的外接程序：以与调试 Blazor Web 应用程序相同的方式调试加载项。 请参阅 调试 ASP.NET Core Blazor WebAssembly。

一般指导

如果要查找有关调试客户端代码的指南，则第一个变量是开发计算机的操作系统。

• Windows
• Mac
• Linux 或其他 Unix 变体

在 Windows 上调试

下面提供了有关在 Windows 上进行调试的常规指南。 在 Windows 上调试取决于 IDE。

• Visual Studio：使用浏览器的 F12 工具进行调试。 请参阅 在 Visual Studio 中调试 Office 加载项。

• 任何其他 IDE (或者你不想在 IDE 中调试) ：使用与外接程序在开发计算机上使用的 Webview 控件关联的开发人员工具。 请查看下列内容之一：

  • 对于 Trident Webview： 使用适用于 Internet Explorer 的开发人员工具调试加载项
  • 对于 EdgeHTML Web 视图： 使用旧版 Edge 的开发人员工具调试加载项
  • 对于 WebView2 Webview： 使用 Microsoft Edge 中的开发人员工具调试加载项 (基于 Chromium 的)

有关正在使用哪些运行时的信息，请参阅 Office 外接程序使用的浏览器和 Web 视图控件 和 Office 外接程序中的运行时。

提示

在 Office 的最新版本中，标识 Office 正在使用的 Web 视图控件的一种方法是通过任何加载项上的 个性菜单 （如果有）。 (Outlook 中不支持“个性”菜单。) 打开菜单并选择“ 安全信息”。 在 Windows 上的“安全信息”对话框中，运行时报告Microsoft Edge、Microsoft Edge 旧版或 Internet Explorer。 旧版 Office 中的对话框中不包含运行时。

在 Mac 上调试

使用 Safari Web 检查器。 说明位于 在 Mac 上调试 Office 加载项 中。

在 Linux 上调试

没有适用于 Linux 的 Office 桌面版本，因此需要 将加载项旁加载到 Office 网页版 才能对其进行测试和调试。 调试指南位于 在 Office 网页版中调试加载项 中。

注意

除可以确保所有加载项用户都将从 Linux 计算机通过 Office 网页版访问加载项的少数情况以外，我们不建议在 Linux 计算机上开发 Office 加载项。

在暂存或生产中调试加载项

要调试已在暂存或生产中的加载项，请从加载项的 UI 附加调试程序。 要了解说明，请参阅 从任务窗格中附加调试程序。

另请参阅

• Office 加载项中的运行时