setCustomerReportData

Включайте пользовательскую информацию, заданную в массив структур в отчете инспекции кода

Описание

пример

setCustomerReportData(cfgObj,customDataStruct) включает пользовательскую информацию, заданную в массив структур в разделе заголовка отчета инспекции кода как строки. Необходимо задать пользовательскую информацию в массиве структур в этом формате:

  • Каждая структура в массиве структур должна содержать два поля.

  • Значение первого поля должно быть строкой.

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

Если информация не задана в этом формате, вы получаете ошибку, когда вы вызываете setCustomerReportData функция. Чтобы включать пользовательскую информацию в отчет, можно также задать их в файле JSON. В этом случае используйте setCustomerReportDataJson функция.

Примеры

свернуть все

  1. Создайте объект инспекции кода для модели slcidemo_roll_orig.

    config = slci.Configuration('slcidemo_roll_orig');

  2. Сгенерируйте код из модели.

    slbuild('slcidemo_roll_orig');

  3. Задайте пользовательскую информацию в массиве структур в поддерживаемом формате.

    % Declare a struct that has two fields
    customDataStruct = struct('FIELDNAME',[],'STATUSMAP',[] );
    % Load custom data in the struct
    customDataStruct(1).FIELDNAME = 'Mathworks PSP Version'
    customDataStruct(1).STATUSMAP = 'N/A'
    customDataStruct(2).FIELDNAME = 'Model & Library Git ID'
    customDataStruct(2).STATUSMAP = struct('MODEL_NAME','slcidemo_roll_orig',...
    'GIT_COMMIT_ID','please review','MODEL_STATUS','NOT DIRTY');
    

  4. Чтобы включать пользовательские данные в отчет инспекции кода, вызовите функциональный setCustomerReportData.

    setCustomerReportData(config,customDataStruct);

  5. Запустите контроль при помощи inspect функция.

    inspect(config);

  6. Просмотрите акт осмотра сгенерированного кода.

    web(fullfile('slprj','slci','slcidemo_roll_orig_report.html'));

    Code inspection report with custom information

Входные параметры

свернуть все

Используйте slci.Configuration функция, чтобы создать Simulink® Настройка Code Inspector™ возражает для модели.

Массив структур, содержащий пользовательскую информацию.

Введенный в R2021b