Категория «Создание кода» > «Комментарии» включает параметры настройки комментариев в созданном коде. Для этих параметров требуется лицензия Simulink ® Coder™. Дополнительные параметры, доступные для целевого объекта на основе ERT, требуют лицензии Embedded Coder ®.
Комментарии к коду создаются автоматически или их можно добавить в код.
Комментарии кода используются следующим образом:
Повышение читаемости и прослеживаемости кода
Передача информации между пользователями
Расширение поиска кода в базе кода
Комментарии кода можно разделить на Автоматически сгенерированные и Настраиваемые комментарии. Автоматически создаваемые комментарии автоматически генерируются программой во время создания кода, и пользователь добавляет пользовательские комментарии.
В диалоговом окне «Параметры конфигурации» на панели «Создание кода» > «Комментарии» находятся следующие параметры конфигурации.
| Параметр | Описание |
|---|---|
Включить комментарии (Simulink Coder) | Укажите, какие комментарии находятся в созданных файлах. |
Комментарии блока Simulink (кодер Simulink) | Укажите, следует ли вставлять комментарии блока Simulink. |
Трассировка по модели с использованием (встроенный кодер) | Укажите формат комментариев для блоков Simulink, элементов Stateflow ® и функциональных блоков MATLAB ®. |
Комментарии объекта Stateflow (Simulink Coder) | Укажите, следует ли вставлять комментарии объекта Stateflow. |
Исходный код MATLAB в виде комментариев (Simulink Coder) | Укажите, следует ли вставлять исходный код MATLAB в качестве комментариев. |
Показать устраненные блоки (Simulink Coder) | Укажите, следует ли вставлять комментарии устраненного блока. |
Подробные комментарии для класса хранения «Модель по умолчанию» (Simulink Coder) | Уменьшите размер кода или улучшите отслеживание кода, управляя созданием комментариев. |
Аннотации операторов (встроенный кодер) | Укажите, следует ли включать аннотации операторов для Polyspace ® в созданный код в качестве комментариев. |
| Параметр | Описание |
|---|---|
Описания блоков Simulink (встроенный кодер) | Укажите, следует ли вставлять описания блоков в созданный код в виде комментариев. |
Описания объектов потока состояний (встроенный кодер) | Укажите, следует ли вставлять описания объектов Stateflow в созданный код в виде комментариев. |
Описания объектов данных Simulink (встроенный кодер) | Укажите, следует ли вставлять описания объектов данных Simulink в созданный код в виде комментариев. |
Требования в комментариях к блокам (встроенный кодер) | Укажите, следует ли включать описания требований, назначенные блокам Simulink, в созданный код в качестве комментариев. |
Пользовательские комментарии (только объекты MPT) (встроенный кодер) | Укажите, следует ли включать пользовательские комментарии к сигналу инструмента упаковки модулей (MPT) и объектам данных параметров в сгенерированный код. |
Комментарии пользователя MATLAB (встроенный кодер) | Укажите, следует ли включать комментарии пользователя MATLAB в качестве комментариев. |
Функция пользовательских комментариев (встроенный кодер) | Укажите файл, содержащий комментарии, которые должны быть включены в сгенерированный код для объектов данных сигналов и параметров инструмента упаковки модуля (MPT). |
Следующие параметры конфигурации находятся в разделе Дополнительные параметры.
| Параметр | Описание |
|---|---|
Стиль комментариев (встроенный кодер) | Укажите стиль многострочного или однострочного комментария для сгенерированного кода C или C++. |
| Вставка комментариев Polyspace (встроенный кодер) | Укажите, следует ли вставлять комментарии кода для аннотаций блоков Polyspace. |
Программа создания кода автоматически вставляет комментарии в созданный код для пользовательских блоков. Поэтому нет необходимости включать комментарии блока в связанный файл TLC для пользовательского блока.
Примечание
Если существуют TLC-файлы с вставленными вручную комментариями для описаний блоков, процесс создания кода выдает эти комментарии вместо автоматически создаваемых комментариев. Рекомендуется удалить существующие комментарии блоков из файлов TLC. Вставленные вручную комментарии могут быть плохо отформатированы в созданном коде, и отслеживание кода в модели может не работать.
Для виртуальных блоков или блоков, которые были удалены из-за сокращения блоков, комментарии не создаются.
При настройке генератора кода для создания кода, содержащего комментарии, генератор кода включает текст для параметров модели, имен блоков, имен сигналов и имен объектов Stateflow в созданные комментарии кода. Если текст содержит символы, которые не представлены в кодировке набора символов для модели, генератор кода заменяет символы escape-последовательностями XML. Например, генератор кода заменяет японскую полноширинную букву Katakana ア на escape-последовательность ア. Дополнительные сведения см. в разделе Интернационализация и создание кода (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 в качестве комментария. Значение константы требует преобразования типа для соответствия типу выходных данных.