Visão geral da depuração de Suplementos do Office

A depuração de Suplementos do Office é essencialmente a mesma que a depuração qualquer aplicativo Web. No entanto, um único conjunto de ferramentas não funcionará para todos os desenvolvedores de suplementos. Isso ocorre porque os suplementos podem ser desenvolvidos em diferentes sistemas operacionais e executados em várias plataformas. Este artigo ajuda você a encontrar as diretrizes de depuração detalhadas para seu ambiente de desenvolvimento.

Dica

Este artigo está preocupado com a depuração no sentido estrito de definir pontos de interrupção e percorrer o código. Para obter as diretrizes sobre testes e solução de problemas, comece com Testar Suplementos do Office e Solução de problemas de erros de desenvolvimento com Suplementos do Office.

Observação

Embora você deva testar seu suplemento em todas as plataformas às quais deseja oferecer suporte, você raramente precisará depurar em um ambiente diferente do seu computador de desenvolvimento. Por esse motivo, este artigo utiliza “seu computador de desenvolvimento” e “seu ambiente de desenvolvimento” para se referir ao ambiente no qual você está depurando. Se um problema no código ocorrer apenas em uma plataforma diferente daquela em seu computador de desenvolvimento e você precisar definir pontos de interrupção ou percorrer o código para resolvê-lo, o ambiente no qual você está depurando não é literalmente seu ambiente de desenvolvimento.

Do lado do servidor ou do lado do cliente?

Depurar o código do lado do servidor de um suplemento do Office é o mesmo que depurar o lado do servidor de qualquer aplicativo Web. Veja as instruções de depuração do seu IDE ou de outras ferramentas. A seguir estão alguns exemplos de algumas das ferramentas mais populares.

• Depurar aplicativos ASP.NET ou ASP.NET Core no Visual Studio
• Depuração Expressa
• Guia de depuração do Node.js
• Depuração do Node.js no VS Code
• Depuração do Webpack

O restante deste artigo está preocupado apenas com a depuração do JavaScript do lado do cliente (que pode ser transpilado do TypeScript).

Casos especiais

Existem alguns casos especiais em que o processo de depuração difere do normal para uma determinada combinação de plataforma, aplicativo do Office e ambiente de desenvolvimento. Se você estiver depurando qualquer um desses casos especiais, use os links nesta seção para encontrar a orientação adequada. Caso contrário, vá para Orientação geral.

• Depurando a função Office.initialize ou Office.onReady:Depure as funções initialize e onReady.
• Depuração de uma função personalizada do Excel em um ambiente de execução não compartilhado: Depuração de funções personalizadas em um ambiente de execução não compartilhado.
• Depurando um comando de função em um ambiente de execução não compartilhado:
  • Suplementos do Outlook em um computador de desenvolvimento Windows: Comandos de função de depuração em suplementos do Outlook
  • Outros suplementos de aplicativos do Office ou Outlook em um computador de desenvolvimento Mac: Depure um comando de função com um tempo de execução não compartilhado.
• Depurando um suplemento do Outlook baseado em eventos ou relatório de spam: Depurar suplementos baseados em eventos e relatórios de spam.
• Depurando um suplemento no novo cliente da área de trabalho do Outlook no Windows (versão prévia): confira a seção "Depurar seu suplemento" de Desenvolver suplementos do Outlook para o novo Outlook no Windows (versão prévia).
• Depurando um suplemento baseado em Blazor: depure o suplemento da mesma maneira que você depuraria um aplicativo Web Blazor. Consulte Depurar ASP.NET Core WebAssembly do Blazor.

Diretrizes gerais

Para encontrar as diretrizes para depurar o código do lado do cliente, a primeira variável é o sistema operacional do seu computador de desenvolvimento.

• Windows
• Mac
• Linux ou outra variante Unix

Depurar no Windows

A seguir, as diretrizes gerais para a depuração no Windows. A depuração no Windows depende do seu IDE.

• Visual Studio: depurar usando as ferramentas F12 do navegador. Consulte Depurar Suplementos do Office no Visual Studio.

• Visual Studio Code: Depure usando a Extensão do Depurador de Suplemento para Visual Studio Code.

• Qualquer outro IDE (ou você não deseja depurar dentro de seu IDE): use as ferramentas de desenvolvedor associadas ao controle webview que os suplementos usam em seu computador de desenvolvimento. Confira um dos procedimentos a seguir:

  • Para a visão web do Trident: Depurar suplementos usando ferramentas de desenvolvedor para Explorer de Internet
  • Para a visão web do EdgeHTML: Depurar suplementos usando ferramentas de desenvolvedor para o Edge Legacy
  • Para a webview do WebView2: Depurar suplementos usando ferramentas de desenvolvedor no Microsoft Edge (baseado em Chromium)

Para obter informações sobre qual runtime está sendo usado, consulte Navegadores e controles webview usados por Suplementos do Office e Runtimes em Suplementos do Office.

Dica

Em versões recentes do Office, uma maneira de identificar o controle webview que o Office está usando é por meio do menu de personalidade em qualquer suplemento em que ele está disponível. (O menu de personalidade não tem suporte no Outlook.) Abra o menu e selecione Informações de Segurança. Na caixa de diálogo Informações de Segurança no Windows, o Runtime relata microsoft Edge, Versão Prévia do Microsoft Edge ou Internet Explorer. O runtime não está incluído na caixa de diálogo em versões mais antigas do Office.

Depurar no Mac

Use o Inspetor Web do Safari. As instruções estão em Depurar Suplementos do Office em um Mac.

Depurar no Linux

Não há uma versão de área de trabalho do Office para Linux, então será necessário fazer o sideload do suplemento para o Office na Web para testá-lo e depurá-lo. As diretrizes de depuração estão em Depurar suplementos no Office na Web.

Observação

Não recomendamos que você desenvolva Suplementos do Office em um computador Linux, exceto no caso incomum em que você pode ter certeza de que todos os usuários do suplemento acessarão o suplemento por meio do Office na Web a partir de um computador Linux.

Depurar suplementos em preparo ou produção

Para depurar um suplemento que já está em preparo ou produção, anexe um depurador da interface do usuário do suplemento. Para obter instruções, Anexe um depurador no painel de tarefas.

Confira também

• Runtimes em suplementos do Office