Сконфигурируйте Polyspace как вас расширение кода в коде Visual Studio

Polyspace, когда Вы Кодируете, позволяет вам находить ошибки при кодировании в IDE Visual Studio Кода.

После установки Polyspace как Вы механизм Анализа кода и расширение IDE, сконфигурируйте расширение так, чтобы Polyspace® анализ запускается гладко, когда вы сохраняете свой код или явным образом запускаете анализ. Анализ запустился гладко, если результаты появляются как ожидалось, или как маркеры исходного кода с подсказками или в списке на панели PROBLEMS.

Чтобы сконфигурировать расширение, в Коде Visual Studio, открывают интерфейс настроек путем нажатия Ctrl + , (запятая) и вводят polyspace в панели поиска настроек.

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

  • Чтобы задать глобальные настройки, введите настройки во вкладку User.

  • Чтобы заменить глобальные настройки для в настоящее время открытой рабочей области или папки, введите настройки во вкладку Workspace.

Если в противном случае не задано, настройки, которые доступны на вкладке User, также доступны на вкладке Workspace.

Visual Studio Code User and Workspace settings tabs

Чтобы сбросить установку на ее значение по умолчанию, кликнитеsettings icon по значку слева от установки и выберите Reset Setting. Все настройки сохраняют свои текущие значения, когда вы переустанавливаете расширение.

Совет

Введите ID Установки в панели поиска настроек, чтобы просмотреть только настройки, связанные с тем ID.

Аналитический Engine

Установка ID: polyspace.analysisengine

Эти настройки обязательны. Для лучшей эффективности на Windows®, путь, что вы предусматриваете эти настройки, не должен указывать на сетевые диски.

УстановкаОписание
Polyspace Installation Folder

Корневая папка Polyspace, когда Вы Кодируете установку, например, C:\Program Files\Polyspace as You Code\R2021b.

Эта установка не доступна на вкладке Workspace.

Working Directory

Папка, где результаты анализа хранятся. Каждый новый запуск перезаписывает результаты предыдущего запуска. Если вы не задаете путь к папке, Polyspace создает Working Directory во временной папке вашей системы:

  • /tmp в Linux®.

  • C:\users\%username%\AppData\Local\Temp в Windows.

Аналитический режим запуска

Установка ID: polyspace.analysisoptions.analysislaunchmode

По умолчанию Polyspace, когда Вы Кодируете запуски каждый раз, вы сохраняете свой код. Можно принять решение отключить автоматические запуски.

УстановкаОписание
Analysis Options: Analysis Launch Mode

Выберите, когда Polyspace, когда Вы Закодируете запуски:

  • Automatically (значение по умолчанию): анализ работает, каждый сохраняет.

  • Manually: Примите решение явным образом запустить анализ. Можно щелкнуть правой кнопкой по исходному коду или файлу в EXPLORER и выбрать Run Polyspace Analysis (или запустить команду Polyspace: Run Polyspace Analysis от Command Palette).

Аналитический Setup

Установка ID: polyspace.analysisoptions.analysissetup

Можно настроить Polyspace как Вы Анализ кода посредством дополнительных настроек или заменить дополнительные настройки и запустить скрипт вместо этого. По умолчанию анализ использует дополнительные настройки.

УстановкаОписание
Analysis Options: Analysis Setup

Выберите между ручной настройкой и скриптом.

  • Manual Setup (значение по умолчанию): Настройте Polyspace, когда Вы Кодируете посредством дополнительных настроек. Задайте связанные со сборкой и другие опции через группу Manual Setup настроек.

    Смотрите Опции анализа> Ручной Setup.

  • Script: Запустите скрипт каждый раз, когда вы сохраняете свой код (или щелкните правой кнопкой по исходному файлу и выберите Run Polyspace Analysis).

    Смотрите Опции анализа> Скрипт.

Опции анализа> Ручной Setup

Установка ID: polyspace.analysisoptions.manualsetup

Ручная настройка анализа включает опции сборки определения, средства проверки и другие опции анализа. Извлеките опции сборки из задачи сборки Visual Studio Кода или файла Базы данных Компиляции JSON, или задайте их явным образом в файле опций сборки. Включите или отключите средства проверки в окне выбора средств проверки. Задайте все остающиеся опции анализа явным образом в файле опций.

УстановкаОписание
Analysis Options > Manual Setup: Build

Спецификация связанных со сборкой опций анализа Polyspace. Опции:

  • Build options file not required (значение по умолчанию)

    Вы не должны задавать опции Polyspace, связанные с созданием ваших файлов. Это - основная опция для простых проектов, где опции анализа Polyspace по умолчанию достаточны, чтобы скомпилировать файлы.

  • Get from build command

    Polyspace использует вашу команду сборки, чтобы сгенерировать файл опций сборки. Убедитесь, что команда создает все исходные файлы в вашей рабочей области. Задайте команду сборки в установке Analysis Options > Manual Setup > Build Setting: Build Command.

    Чтобы сгенерировать файл опций сборки, от Command Palette, запускают Polyspace: Configure Project.

    Смотрите получают конфигурацию сборки от команды сборки

  • Get from build task

    Polyspace использует вашу задачу сборки Visual Studio сгенерировать файл опций сборки. Убедитесь, что задача сборки выполняет полную сборку всех файлов в вашей рабочей области. Задайте имя задачи сборки в установке Analysis Options > Manual Setup > Build Setting: Build Task.

    Чтобы сгенерировать файл опций сборки, от Command Palette, запускают Polyspace: Configure Project.

    Смотрите получают конфигурацию сборки от задачи сборки.

  • Get from JSON Compilation Database file

    Polyspace использует вашу базу данных компиляции JSON, чтобы сгенерировать файл опций сборки. Задайте путь к файлу базы данных (обычно названный compile_commands.json) в установке Analysis Options > Manual Setup > Build Setting: JSON Compilation Database File.

    Чтобы сгенерировать файл опций сборки, от Command Palette, запускают Polyspace: Configure Project.

    Смотрите получают конфигурацию сборки от базы данных компиляции JSON.

  • Get from Polyspace build options file

    Предоставьте возможности сборки в файле опций, который вы задаете в установке Analysis Options > Manual Setup > Build Setting: Polyspace Build Options File.

    См. также Файлы Опций для Анализа Polyspace.

Analysis Options > Manual Setup > Build Setting: Build Command

Используйте эту установку, если вы выбираете Get from build command для установки Analysis Options > Manual Setup: Build.

Задайте название команды сборки точно так же, как вы ввели бы в терминал командной строки или консоль.

Используйте команду сборки, которая выполняет полную сборку всех файлов в вашей рабочей области и не инкрементную сборку.

Смотрите получают конфигурацию сборки от команды сборки

Analysis Options > Manual Setup > Build Setting: Build Task

Используйте эту установку, если вы выбираете Get from build task для установки Analysis Options > Manual Setup: Build.

Задайте имя задачи сборки. Имя задачи сборки является именем команды, которая запускается, когда вы выбираете Terminal> Run Task. Для получения дополнительной информации о задачах см. документацию Visual Studio Кода.

Используйте задачу сборки, которая выполняет полную сборку всех файлов в вашей рабочей области и не инкрементную сборку.

Смотрите получают конфигурацию сборки от задачи сборки.

Analysis Options > Manual Setup > Build Setting: JSON Compilation Database File

Используйте эту установку, если вы выбираете Get from JSON Compilation Database File для установки Analysis Options > Manual Setup: Build.

Задайте полный путь к файлу базы данных (обычно названный compile_commands.json).

Смотрите получают конфигурацию сборки от базы данных компиляции JSON.

Analysis Options > Manual Setup > Build Setting: Polyspace Build Options File

Используйте эту установку, если вы выбираете Get from Polyspace Build Options File для установки Analysis Options > Manual Setup: Build.

Задайте полный путь к файлу опций сборки Polyspace. Файл опций является текстовым файлом с одной опцией анализа Polyspace на строку.

См. также Файлы Опций для Анализа Polyspace.

Analysis Options > Manual Setup: Checkers File

Задайте полный путь к конфигурационному файлу средств проверки.

Чтобы создать этот файл, в Command Palette, запускают Polyspace: Configure Checkers. Включите средства проверки, что вы хотите и сохранили файл.

См. также Конфигурируют Средства проверки для Polyspace, когда Вы Кодируете в Коде Visual Studio.

Analysis Options > Manual Setup: Other Analysis Options

Путь к файлу опций. Файл опций содержит одну опцию анализа Polyspace на строку. Например:

-termination-functions exit_handler
-code-behavior-specifications /usr/jdoe/util/checkerModifiers.xml

Вы обычно не должны задавать дополнительные опции в файле опций. Однако в некоторых ситуациях, вы можете хотеть использовать файл опций. Например, вы можете хотеть изменить некоторые средства проверки с помощью XML-файла, что вы предоставляете опцию -code-behavior-specifications.

См. также Файлы Опций для Анализа Polyspace.

Опции анализа> Скрипт

Установка ID: polyspace.analysisoptions.scriptfile

УстановкаОписание
Analysis Options > Script: Script File

Используйте эту установку, если вы выбираете Script для установки Analysis Options: Analysis Setup.

Введите полный путь в скрипт. Скрипт может быть написан в любом языке и запускается каждый раз, когда вы запускаете Polyspace, когда Вы Кодируете на файле, сохраняют или явным образом.

Расширение передает эти параметры скрипту:

  • Путь к текущему файлу в качестве первого аргумента.

  • Путь Working Directory в качестве второго аргумента.

  • Путь Polyspace Installation Folder в качестве третьего аргумента.

Например, этот простой сценарий пакетной обработки Windows анализирует текущий файл, использует опции сборки Polyspace по умолчанию и импортирует информацию об анализе из ранее загруженной базовой линии:

set INSTALL_DIR=%3
set ANALYZE=%INSTALL_DIR%\polyspace\bin\polyspace-bug-finder-access.exe
set SOURCES=%1
set RESULTS_FOLDER=%2
set BASELINE_DIR=%RESULTS_FOLDER%\..\..\..\baseline


"%ANALYZE%" -sources %SOURCES% -baseline-folder %BASELINE_DIR% -results-dir %RESULTS_FOLDER% 
IF %ERRORLEVEL% NEQ 0 EXIT 1

Используйте скрипт, если, например, вы переключаетесь между файлами от компонентов, которые имеют различные конфигурации сборки, или вы используете инструмент пользователя, чтобы установить вашу среду сборки.

Если вы включаете эту установку, все другие дополнительные настройки проигнорированы.

Примечание

Polyspace как Вы Расширение кода не проверяет статус выхода команд в вашем скрипте. Убедитесь, что ваш скрипт проверяет коды выхода (например, при помощи %ERRORLEVEL%) и возвращает значимый статус выхода.

Как правило, двоичные файлы Polyspace возвращаются 0 на успехе и ненулевом значении на отказе.

BaseLine

Установка ID: polyspace.baseline

Установите эти опции, если вы хотите сравнить свои локальные результаты с базовой линией от Polyspace доступ. После того, как вы получаете базовую линию из Polyspace доступ, последующие запуски Polyspace, когда Вы Кодируете, позволяют вам различать новые результаты и результаты, которые присутствовали в существующем коде. См. также Базовый Polyspace, когда Вы Кодируете Результаты в Коде Visual Studio.

УстановкаОписание
Baseline: Polyspace Access Login

Задайте имя пользователя, которое вы используете, чтобы войти в систему Polyspace доступ.

Позже, когда вы запускаете Polyspace: Download Baseline в Command Palette, вам предлагают пароль, который соответствует этому имени пользователя.

Baseline: Polyspace Access Url

Задайте Polyspace доступ к URL, например, https://example.access-server:9443.

Baseline: Project

Задайте путь проекта на Polyspace доступ к этому, вы используете в качестве базовой линии.

Чтобы загрузить базовую линию, от Command Palette, запускают Polyspace: Download Baseline.

См. также Базовый Polyspace, когда Вы Кодируете Результаты в Коде Visual Studio.

Baseline: Show Baseline Information

Включите или отключите использование информации от базового запуска:

  • Show local findings only (значение по умолчанию)

    Когда вы запускаете анализ, Polyspace не использует информацию от базового запуска. Вы видите только локальные результаты в панели PROBLEMS.

  • Show local findings and baseline info

    Когда вы запускаете анализ, информацию об анализе импорта Polyspace от базового запуска. Результаты, которые уже выравниваются по ширине в базовом запуске, подавлены в панели PROBLEMS.

  • Show new findings only

    Когда вы запускаете анализ, информацию об анализе импорта Polyspace от базовой линии. Результаты, которые уже присутствуют в базовом запуске, подавлены в панели PROBLEMS.

    Используйте эту установку, чтобы фокусироваться только на новых результатах.

См. также Базовый Polyspace, когда Вы Кодируете Результаты в Коде Visual Studio.

Другие настройки

Установка ID: polyspace.othersettings

Дополнительные настройки, чтобы сконфигурировать режим отладки и порт дополнительное использование, чтобы связаться с аналитическим механизмом.

УстановкаОписание
Other Settings: Debug Mode

Включите или отключите отладку.

  • Disabled(значение по умолчанию)

    Покажите только ошибки, предупреждения и информационные сообщения, такие как начало и конец анализа в панели OUTPUT.

  • Enabled

    Покажите всю отладочную информацию в панели OUTPUT. Позвольте этой установке диагностировать проблемы с Polyspace как Вы Расширение кода.

Other Settings: Port

Задайте номер порта что Polyspace как Вы использование Расширения кода, чтобы связаться с аналитическим механизмом.

Используйте эту установку, если, например, ваша машина сконфигурирована с брандмауэром, и вы хотите задать открытый порт в брандмауэре.

Если вы задаете 0 (значение по умолчанию), Polyspace запрашивает вашу систему для доступного порта и использует, какой бы ни портируют вашу систему, возвращается.

Вы можете должны быть перезагрузить Код Visual Studio после того, как вы измените эти настройки. Вы можете должны быть повторно выполнить Polyspace: Configure Project после того, как вы перезагружаете Код Visual Studio, если вы задаете порт 0.

Сконфигурируйте Polyspace, в то время как вы кодируете для удаленной разработки

Polyspace как Вы Расширение кода поддерживает функцию удаленной разработки Visual Studio Кода. Смотрите Удаленную разработку VS Кода.

С удаленной разработкой можно запустить Polyspace как Вы Анализ кода от вашей локальной машины на коде, который вы разрабатываете и редактируете на удаленной машине. Чтобы включить удаленную разработку, см. Удаленные примеры.

Когда вы включаете удаленную разработку:

  • Polyspace как Вы Расширение кода отключен на вашей локальной машине. Вы используете Polyspace в качестве Вас Расширение кода на удаленной машине, чтобы запустить анализ.

  • Вы видите дополнительную вкладку в настройках расширения Polyspace. Вы конфигурируете расширение на удаленной машине в этой вкладке.

Похожие темы