Отладка скриптов - BazisSoft/Scripts GitHub Wiki
Начиная с 10-й версии Базис-Мебельщик поддерживает отладку скриптов через Visual Studio Code в ОС Microsoft Windows 7 и выше. Для установки Visual Studio Code перейдите по ссылке https://code.visualstudio.com/download и выберите загрузку для Windows. После загрузки откройте установщик и следуйте инструкциям по установке.
Данная страница поможет вам настроить Visual Studio Code для отладки скриптов в модуле Базис-Мебельщик.
Процесс отладки призван ускорять поиск ошибок в скрипте путем остановки скрипта в нужном месте и просмотра данных.
Редактор Visual Studio Code позволяет отлаживать некоторые программы и скрипты с помощью расширений. Одним из таких расширений является bazis-debug
, которое позволяет отлаживать скрипты в модуле Базис-Мебельщик.
Для отладки скриптов в Visual Studio Code необходимо:
- Установить Visual Studio Code и расширение Базис-Отладчик. Рекомендуем ознакомиться с инструкцией "Настройка VSCode для редактирования скриптов".
- Настроить файл конфигурации.
После выполнения всех действий можно приступать непосредственно к отладке.
Для отладки скрипта в Visual Studio Code вам необходимо настроить файл конфигурации launch.json
. Этот файл содержит настройки взаимодействия отладчика Visual Studio Code и модуля Базис-Мебельщик. Файл конфигурации можно автоматически сгенерировать, для этого выполните следующие действия:
- Откройте вкладку "Отладка"
- Нажмите кнопку "Открыть launch.json"
. Если файл конфигурации отсутствует, он будет создан в открытой папке.
- Добавьте новую конфигурацию. Для отладки скриптов в модуле Базис-Мебельщик выберите
Базис
. - Настройте файл конфигурации, или воспользуйтесь стандартными сгенерированными настройками.
Основные параметры файла конфигурации:
-
type
- тип среды отладки. Используемое значение -bazis
. -
request
- тип запуска отладчика. Используемое значение -launch
. -
name
- название конфигурации. Используется для отображения в окне отладки. По умолчаниюЗапустить программу
. -
program
- полный путь к файлу запускаемого скрипта. По умолчанию${file}
- текущий открытый файл в редакторе. -
stopOnEntry
- параметр, указывающий, приостанавливать ли скрипт во время вхождения на первой строке. По умолчаниюfalse
. -
noDebug
- запуск скрипта без отладки. По умолчаниюfalse
. -
args
- дополнительные аргументы, передаваемые в Базис-Мебельщик. По умолчанию[]
. -
sourceMaps
- использовать Javascript source maps (Необходимо для отладки Typescript). По умолчаниюfalse
. -
port
- порт отладки. По умолчанию5858
. -
address
- сетевой адрес компьютера. По умолчаниюlocalhost
. -
timeout
- время (в мс), в течение которого ждать подключения. По умолчанию10000
.
Точки останова позволяют остановить скрипт во время выполнения и посмотреть значения переменных, для определения правильности выполнения скрипта. Строка кода, на которой стоит точка останова, будет выполняться следующей. Чтобы установить точку останова, поставьте курсор на нужную строку и нажмите F9, либо нажмите ЛКМ возле номера строки.
Также точке останова можно задать условие, при этом отладчик остановится на ней только тогда, когда условие равно true
. Пример: переменной bar
установили значение 45
. Если после определения переменной поставить точку останова и задать ей условие bar > 100
, то программа в этой точке никогда не остановится. Если поставить условие bar < 100
, то программа всегда будет останавливаться в этой точке.
Перед отладкой необходимо выполнить следующие действия:
- Откройте скрипт, который хотите отладить (если у вас параметр
program
равен${file}
) - Установите точки останова
- Перейдите на вкладку "Отладка"
- Нажмите кнопку "Начать отладку".
Если параметрstopOnEntry
равенfalse
и не активна ни одна точка останова, то скрипт просто выполнится, как будто был запущен в редакторе скриптов в приложении.
Для запуска отладки вместо выполнения пунктов 3 и 4 можно нажать кнопку F5.
Для перехода к следующему действию в скрипте нажмите кнопку "Шаг с обходом" F10 , для пошаговой отладки метода (захода внутрь) нажмите кнопку "Шаг с заходом" F11
.
В секции "Контрольное значение" вы можете просмотреть значения переменных или выражений. Для добавления выражения нажмите кнопку "Добавить выражение" в секции "Контрольное значение" и введите выражение в появившееся окно для ввода. Внимание: НЕ следует использовать оператор присваивания =
в секции просмотра выражений, это перезапишет переменную.
-
В: У меня в скрипте вместо кириллицы отображаются непонятные символы.
О: Это проблемы с кодировкой. Следует пересохранить файл в кодировке UTF-8 (с BOM). -
В: В какой папке следует хранить конфигурационный файл
launch.json
?
О: Мы советуем хранить конфигурационный файл в корневой папке скриптов. В Visual Studio Code есть встроенный проводник. Он показывает все файлы и папки, находящиеся в корневой открытой папке, и позволяет создать новые файлы и папки.
-
В: Если я сохраню файл скрипта в кодировке UTF-8(с BOM), смогу ли я корректно запустить скрипт в предыдущих версиях модуля?
О: Да, если файл в формате js. Если файл в формате ts, то при отладке будет скомпилирован файл с таким же названием, но расширением js, который вы также сможете использовать в предыдущих версиях модуля.