Параметры конфигурации модели: комментарии

Категория Code Generation > Comments включает параметры для настройки комментариев в сгенерированном коде. Эти параметры требуют Simulink^® Coder™ лицензию. Дополнительные параметры, доступные с целевым устройством на основе ERT, требуют Embedded Coder^® лицензия.

Комментарии к коду генерируются автоматически или можно добавить их в код.

Комментарии к коду имеют следующее использование:

Улучшите читаемость и трассируемость кода
Передача информации среди пользователей
Улучшите поиск кода в основе

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

В диалоговом окне Configuration Parameters следующие параметры конфигурации находятся на панели Code Generation > Comments.

Автоматически сгенерированные комментарии

Параметр	Описание
Включите комментарии (Simulink Coder)	Укажите, какие комментарии находятся в сгенерированных файлах.
Комментарии блока Simulink (Simulink Coder)	Укажите, следует ли вставлять комментарии к блокам Simulink.
Проследите, чтобы смоделировать использование (Embedded Coder)	Задайте формат комментариев для блоков Simulink, Stateflow^® элементы и MATLAB^® функциональные блоки.
Комментарии объекта Stateflow (Simulink Coder)	Укажите, следует ли вставлять комментарии к объектам Stateflow.
Исходный код MATLAB в виде комментариев (Simulink Coder)	Укажите, следует ли вставлять исходный код MATLAB в качестве комментариев.
Покажите устраненные блоки (Simulink Coder)	Укажите, следует ли вставлять комментарии к удаленному блоку.
Подробные комментарии для класса памяти 'Model default' (Simulink Coder)	Уменьшите размер кода или улучшите трассируемость кода, управляя генерацией комментариев.
Аннотации оператора (Embedded Coder)	Укажите, включать ли аннотации оператора для Polyspace^® в сгенерированном коде как комментарии.

Пользовательские комментарии

Параметр	Описание
Описания блоков Simulink (Embedded Coder)	Укажите, следует ли вставлять описания блоков в сгенерированный код в качестве комментариев.
Описания объектов Stateflow (Embedded Coder)	Укажите, следует ли вставлять описание объектов Stateflow в сгенерированный код в виде комментариев.
Описание объекта данных Simulink (Embedded Coder)	Укажите, следует ли вставлять описание объектов данных Simulink в сгенерированный код в виде комментариев.
Требования в комментариях блоков (Embedded Coder)	Укажите, включать ли описание требований, назначенных блокам Simulink, в сгенерированный код в качестве комментариев.
Пользовательские комментарии (только объекты MPT) (Embedded Coder)	Укажите, включать ли пользовательские комментарии для сигнала инструмента упаковки модулей (MPT) и объектов данных о параметрах в сгенерированный код.
Комментарии пользователей MATLAB (Embedded Coder)	Укажите, включать ли комментарии пользователей MATLAB в качестве комментариев.
Функция пользовательских комментариев (Embedded Coder)	Укажите файл, содержащий комментарии, которые будут включены в сгенерированный код для сигнала инструмента упаковки модулей (MPT) и объектов данных о параметрах.

Следующие параметры конфигурации находятся под Advanced parameters.

Параметр	Описание
Стиль комментария (Embedded Coder)	Задайте многострочный или однострочный стиль комментария для сгенерированного кода C or C++.
Вставьте комментарии Polyspace (Embedded Coder)	Укажите, следует ли вставлять комментарии к коду для аннотаций блоков Polyspace.

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

Примечание
Если у вас есть существующие файлы TLC с вручную вставленными комментариями для описаний блоков, процесс генерации кода издает эти комментарии вместо автоматически сгенерированных комментариев. Рассмотрите удаление существующих комментариев блоков из файлов TLC. Вручную вставленные комментарии могут быть плохо отформатированы в сгенерированном коде, а трассируемость кода к модели может не работать.
Для виртуальных блоков или блоков, которые были удалены из-за сокращения блоков, комментарии не генерируются.
Когда вы конфигурируете генератор кода, чтобы создать код, который включает комментарии, генератор кода включает текст для параметров модели, имен блоков, имен сигналов и имен объектов Stateflow в комментариях сгенерированного кода. Если текст включает символы, которые не представлены в кодировке набора символов для модели, генератор кода заменяет символы XML-переходными последовательностями. Например, генератор кода заменяет японскую полноразмерную букву Катаканы ア на выходную последовательность ア. Для получения дополнительной информации смотрите Интернационализация и Генерация кода (Simulink Coder).
Когда вы устанавливаете параметр конфигурации модели Default parameter behavior равным Tunableгенератор кода добавляет различные комментарии относительно параметров числовых блоков в сгенерированном коде в зависимости от числового значения параметров блоков и выхода типа данных. Для образца генератор кода добавляет:
- Computed Parameter как комментарий, когда числовое значение параметров блоков нуждается в преобразовании типа, чтобы соответствовать типу данных выходов.
- Expression как комментарий, когда числовое значение параметров блоков соответствует типу данных выходов без преобразования типа.
Simulink интерпретирует тип данных числового параметра как число двойной точности, если вы явным образом не задаете обратное. Сгенерируйте код для следующей модели:
```
// Parameters (auto storage)
struct P_test_parameter_T_ {
  real_T Constant1_Value;              // Expression: 200
                                          //  Referenced by: '<Root>/Constant1'

  real_T Constant2_Value;              // Computed Parameter: Constant2_Value
                                          //  Referenced by: '<Root>/Constant2'

  int32_T Constant3_Value;             // Computed Parameter: Constant3_Value
                                          //  Referenced by: '<Root>/Constant3'
};
```
Когда постоянное значение составляет 200, и тип выходных данных двойной точности, генератор кода добавляет Expression как комментарий. Simulink интерпретирует тип данных постоянного значения как число двойной точности, и без преобразования типа он соответствует типу выходных данных.
Когда постоянное значение является uint8 (200), и тип выходных данных двойной точности, генератор кода добавляет Computed Parameter как комментарий. Постоянное значение требует преобразования типа, чтобы соответствовать типу выходных данных.
Когда постоянное значение 500, и тип выходных данных int32, генератор кода добавляет Computed Parameter как комментарий. Постоянное значение требует преобразования типа, чтобы соответствовать типу выходных данных.

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