Отладка пользовательских функций

Статья
03/10/2023

В этой статье рассматривается отладка только для пользовательских функций, которые не используют общую среду выполнения. Сведения об отладке надстроек пользовательских функций, использующих общую среду выполнения, см. в статье Настройка надстройки Office для использования общей среды выполнения: Отладка.

Важно!

Обратите внимание, что настраиваемые функции доступны в Excel на следующих платформах.

Office в Интернете
Office для Windows
- Подписка на Microsoft 365
- Розничный бессрочный Office 2016 и более поздних версий
- корпоративные бессрочные Office 2021 и более поздних версий
Office для Mac

Пользовательские функции Excel в настоящее время не поддерживаются в следующих приложениях:

Office для iPad
корпоративные бессрочные версии Office 2019 или более ранних версий в Windows

Примечание.

Мы рекомендуем использовать пользовательские функции с общей средой выполнения, если у вас нет конкретных причин не использовать общую среду выполнения. Обратите внимание, что использование общей среды выполнения означает, что ваша надстройка будет использовать WebView2 (Microsoft Edge Chromium) в случае выполнения условий, а в противном случае ваша надстройка будет использовать Trident (интернет-Обозреватель 11) независимо от версии Windows или Microsoft 365. Описание условий WebView2 см. в статье Браузеры и элементы управления webview, используемые надстройками Office. Дополнительные сведения о средах выполнения см. в разделе Среды выполнения в надстройках и средах выполнения Office.

Совет

Методы отладки, описанные в этой статье, не работают с проектами, созданными с помощью проекта надстройки Office, содержащего параметр только манифест в генераторе Yeoman. Скрипты, которые упоминаются далее в этой статье, не устанавливаются с этим параметром. Чтобы отладить надстройку, созданную с помощью этого параметра, ознакомьтесь с инструкциями в одной из следующих статей.

Процесс отладки пользовательской функции для надстроек, которые не используют общую среду выполнения, зависит от целевой платформы (Windows, Mac или веб-сайта) и от того, используете ли вы Visual Studio Code или другую интегрированную среду разработки. Используйте ссылки в следующей таблице, чтобы просмотреть разделы этой статьи, относящиеся к вашему сценарию отладки. В этой таблице "CF-NSR" относится к пользовательским функциям в необщей среде выполнения.

Целевая платформа	Visual Studio Code	Другая интегрированная среда разработки
Excel в Интернете	Использование VS Code и средств разработки в браузере	Использование средств командной строки
Excel для Windows	Использование VS Code и средств разработки в браузере	Отладка CF-NSR, запущенных в Excel в Windows за пределами VS Code, не поддерживается. Отладка для Excel в Интернете.
Excel для Mac	Отладка VS Code для CF-NSR, запущенных в Excel на Mac, не поддерживается. Отладка для Excel в Интернете.	Использование средств командной строки

Используйте средства разработчика браузера для отладки пользовательских функций в Excel в Интернете

Средства разработчика браузера можно использовать для отладки пользовательских функций, которые не используют общую среду выполнения в Excel в Интернете. Следующие действия работают как для Windows, так и для macOS.

Запуск надстройки из Visual Studio Code

Откройте корневую папку проекта пользовательских функций в Visual Studio Code (VS Code).
Выберите Терминал > Запустить задачу и введите или нажмите кнопку Контроль. Это позволит отслеживать и перестраивать все изменения файлов.
Выберите Задача запуска терминала > и введите или выберите Сервер разработки.

Загрузка неопубликованной надстройки

Откройте Office в Интернете.
Откройте новую книгу Excel.
Выберите Главная>надстройки, а затем выберите Получить надстройки.
В диалоговом окне Надстройки Office перейдите на вкладку MY ADD-INS , выберите Управление моими надстройками, а затем — Отправить мою надстройку.
Найдите файл манифеста надстройки и выберите Отправить.

Примечание.

После загрузки неопубликованного документа он будет оставаться неопубликованным при каждом открытии документа.

Начало отладки

Откройте средства разработчика в браузере. Для Chrome и большинства браузеров F12 откроет средства разработчика.
В средствах разработчика откройте файл скрипта исходного кода, используя cmd+P или CTRL+P (functions.js или functions.ts).
Задайте точку останова в исходном коде пользовательской функции.

Если вам нужно изменить код, вы можете внести изменения в VS Code и сохранить изменения. Обновите браузер, чтобы просмотреть загруженные изменения.

Использование средств командной строки для отладки

Если вы не используете VS Code, для запуска надстройки можно использовать командную строку (например, bash или PowerShell). Вам потребуется использовать средства разработчика браузера для отладки кода в Excel в Интернете. Вы не можете выполнить отладку классической версии Excel с помощью командной строки.

Из командной строки выполните watch npm run watch для и перестройте при изменении кода.
Откройте второе окно командной строки (первое будет заблокировано при запуске watch).
Если вы хотите запустить надстройку в классической версии Excel, выполните следующую команду.

npm run start:desktop

Или, если вы предпочитаете запустить надстройку в Excel в Интернете выполните следующую команду.

npm run start:web -- --document {url} (где {url} — URL-адрес файла Excel в OneDrive или SharePoint)

Примечание.

Если вы разрабатываете на компьютере Mac, заключите в одинарные {url} кавычки. Не делайте этого в Windows.

Если надстройка не загружает неопубликованное приложение в документе, выполните действия, описанные в разделе Загрузка неопубликованных приложений, чтобы загрузить неопубликованную надстройку. Затем перейдите к следующему разделу, чтобы начать отладку.
Откройте средства разработчика в браузере. Для Chrome и большинства браузеров F12 откроет средства разработчика.
В средствах разработчика откройте файл скрипта исходного кода (functions.js или functions.ts). Код пользовательских функций может находиться в конце файла.
В исходном коде пользовательской функции примените точку останова, выбрав строку кода.

Если вам нужно изменить код, вы можете внести изменения в Visual Studio и сохранить изменения. Обновите браузер, чтобы просмотреть загруженные изменения.

Команды для сборки и запуска надстройки

Доступно несколько задач сборки.

npm run watch: выполняет сборку для разработки и автоматически перестраивается при сохранении исходного файла.
npm run build-dev: однократно выполняет сборки для разработки.
npm run build: сборки для рабочей среды
npm run dev-server: запускает веб-сервер, используемый для разработки.

Для запуска отладки на рабочем столе или в Сети можно использовать следующие задачи.

npm run start:desktop: запускает Excel на рабочем столе и загружает неопубликованную надстройку.
npm run start:web -- --document {url}(где {url} — URL-адрес файла Excel в OneDrive или SharePoint): запускает Excel в Интернете и загружает неопубликованную надстройку.

Примечание.

Если вы разрабатываете на компьютере Mac, заключите в одинарные {url} кавычки. Не делайте этого в Windows.
npm run stop: останавливает Excel и отладку.

Дальнейшие действия

Сведения о проверке подлинности для пользовательских функций без общей среды выполнения.