Примеры индивидуальных настроек шаблона отчета

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

В этом разделе показаны некоторые индивидуальные настройки, которые можно сделать с Polyspace® шаблон отчета с краткими шагами. Для получения более подробной информации руководство «Настройка существующего шаблона отчета Code Prover».

Для настройки шаблона:

  1. Откройте MATLAB® Сообщите Generator™. В командной строке MATLAB введите:

    report

  2. Откройте существующий шаблон.

    Шаблоны расположены в polyspaceroot/ toolbox/polyspace/psrptgen/templates. polyspaceroot - папка установки Polyspace.

  3. Добавление, удаление или изменение компонентов шаблона.

    Полный список компонентов Polyspace см. в разделе «Генерация отчетов».

Добавление списка рекурсивных функций

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

Начните с шаблона CodeMetrics. В главе о метриках кода добавьте компонент Recursive Functions.

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

Показывать только проверки во время выполнения Red

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

Начните с шаблона Developer. Удалите все главы, кроме таковых, содержащей эти компоненты:

При создании отчета с помощью измененного шаблона отображается обзор проверок, глава с подробными данными только для красных проверок и приложение.

Показывать только необоснованные проверки во время выполнения

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

  • Justified

  • No action planned

  • Not a defect

Добавьте компонент Report Customization (Filtering) над первой главой. Измените компонент так, чтобы в следующих главах были показаны только необоснованные проверки.

Выберите компонент. На правой панели в групповом Advanced Filters из списка Justification Status выберите Un-justified.

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

Добавьте главу для ошибок функционального проектирования

Предположим, что вы реализуете проверку функционального проекта с помощью assert операторы в коде. Например, чтобы проверить, является ли выход функции out находится в пределах области значений [MIN,MAX], ваш код использует оператор:

assert(MIN <= out && out <= MAX);
Polyspace запускает проверку User assertion для определения, является ли assert сбой условия. Предположим, что вы хотите сообщить об этих проверках в отдельной главе, поскольку они отличаются от других проверок ошибок времени выполнения.

Начните с шаблона Developer. Создайте копию главы, содержащей Run-time Checks Details Ordered by Color/File компонента.

Переименуйте каждый из двух заголовков глав так, чтобы вы могли различать их. В каждой главе измените Run-time Checks Details Ordered by Color/File компонента следующим образом:

  • В одной главе исключить проверки User assertion. Выберите компонент. На правой панели в групповой Advanced Filters, для Check types to include, введите:

    ^(?!User assertion).*

  • В другой главе включите User assertion проверки. Выберите компонент. На правой панели в групповой Advanced Filters, для Check types to include, введите:

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

При создании отчета с помощью измененного шаблона отображаются две копии главы о проверках во время выполнения. Первая глава содержит все проверки кроме проверок User assertion, а вторая - только проверки User assertion.

Похожие темы