调试 Office 加载项概述

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

提示

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

服务器端还是客户端?

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

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

特殊情况

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

一般指导

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

注意

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

在 Windows 上调试

在 Windows 上调试取决于 IDE。

在 Mac 上调试

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

在 Linux 上调试

没有适用于 Linux 的 Office 桌面版本,因此需要 将加载项旁加载到 Office 网页版 才能对其进行测试和调试。 请参阅调试 Office web 版 中的加载项

注意

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

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

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

用于调试的 office.js 版本

有调试版本的 Office JavaScript 库。 这些版本更易于人工阅读,并且更易于使用调试器单步执行。 在发布和部署外接程序时避免使用它们。

调试版本位于以下 CDN 位置。

  • Office JavaScript API 库: https://appsforoffice.microsoft.com/lib/1/hosted/office.debug.js
  • Office JavaScript API (预览版) 库: https://appsforoffice.microsoft.com/lib/beta/hosted/office.debug.js

另请参阅