Добавление пользовательских комментариев для переменных в созданный код

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

Дополнительные сведения об объектах данных см. в разделе Объекты данных.

Встроить рукописные комментарии для сигналов или параметров

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

Откройте модель Simulink.
```
openExample('ex_param_array)';
```
Создайте объект данных для представления сигнала, состояния или параметра. Можно использовать объект данных из любого пакета, например Simulink. Например, используйте объект данных классов Simulink.Signal или Simulink.Parameter, которые определены в пакете Simulink.
```
myParam = Simulink.Parameter(15.23);
```
В модели в разделе ПОДГОТОВКА выберите Инспектор свойств. Щелкните целевой блок усиления. Задайте значение параметра myParam.
Задайте класс хранения объекта данных так, чтобы оптимизация не исключала сигнал или параметр из сгенерированного кода. Например, используйте класс хранения ExportedGlobal.
```
myParam.StorageClass = 'ExportedGlobal';
```
Установите Description свойства объекта. Указанное описание отображается в созданном коде в виде строк комментариев.
```
myParam.Description = 'This parameter represents multiplication';
```
В окне Параметры конфигурации модели (Model Configuration Parameters) выберите Описание объекта данных Simulink.

Создайте код из модели. В коде описание объекта данных отображается рядом с определением соответствующей переменной.

/* Exported block parameters */
real_T myParam = 15.23;     /* Variable: myParam
                             * Referenced by: '<S1>/Gain'
                             * This parameter represents multiplication.
                             */

Создание динамических комментариев на основе свойств данных

Можно создавать динамические комментарии, включающие свойства объекта данных, такие как тип данных, единицы измерения и размеры. При изменении свойств объекта данных в Simulink ® генератор кода сохраняет точность комментариев. Например, в этом комментарии отображаются некоторые значения свойств для объекта данных с именемMAP для модели Simulink в предыдущем примере:

Создание объекта данных из пакета mpt и применить к объекту пользовательский класс хранения. Классом хранения по умолчанию является пользовательский класс хранения Global (Custom).
```
myParam = mpt.Parameter;
```
Для создания динамических комментариев необходимо использовать объект данных из пакета mpt и необходимо применить к объекту пользовательский класс хранения.
Напишите функцию MATLAB или TLC, которая генерирует текст комментария. Для примера функции MATLAB ® см. функциюmatlabroot/toolbox/rtw/rtwdemos/rtwdemo_comments_mptfun.m.
Функция должна принимать три входных аргумента, которые соответствуют objectName, modelName, и request. При записи файла TLC можно использовать функцию библиотеки LibGetSLDataObjectInfo для получения значений свойств объекта данных.
Сохраните функцию как файл MATLAB или файл TLC. Поместите файл в папку, расположенную по пути MATLAB.
В окне Параметры конфигурации модели (Model Configuration Parameters) выберите Пользовательские комментарии (только объекты MPT).
Задайте для функции Пользовательские комментарии имя созданного файла MATLAB или файла TLC.
Создайте код из модели. Комментарии, генерируемые функцией, отображаются рядом с кодом, который представляет каждый объект данных.
```
/* Object: myParam - user description:
   DataType -- auto
   Units    --
   CSC      -- Global */
```

Ограничения

Для создания комментариев с помощью опций функции Пользовательские комментарии (только объекты MPT) и Пользовательские комментарии необходимо создать объекты данных из пакета. mpt. Объекты данных должны использовать пользовательский класс хранения.
Только пользовательские классы хранения данных из mpt пакет, создающий неструктурированные переменные, поддерживает функцию пользовательских комментариев.

Документация