setCustomerReportDataJson

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

Описание

пример

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

  • Информация должна быть задана в массиве объектов JSON.

  • Объекты JSON должны быть написаны в Парах ключ/значение.

  • Значение должно быть строкой или массивом объектов JSON в поддерживаемом формате.

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

Примеры

свернуть все

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

    config = slci.Configuration('slcidemo_roll_orig');

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

    slbuild('slcidemo_roll_orig');

  3. Задайте пользовательские данные в файле JSON в поддерживаемом формате. В этом примере используйте их определение.

    [
        {"FIELDNAME":"Mathworks PSP Version", 
         "STATUSMAP":"N/A"},
        {"FIELDNAME":"Model & Library Git ID",
         "STATUSMAP":
            [{"MODEL_NAME":"slcidemo_roll_orig",
              "GIT_COMMIT_ID":"please review",
              "MODEL_STATUS":"NOT DIRTY"}]
        }
    ]
    Сохраните файл JSON как dCustomData в текущей рабочей папке.

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

    setCustomerReportDataJson(config,'dCustomData.json');

  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™ возражает для модели.

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

Введенный в R2021b