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

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

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

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

Улучшите удобочитаемость и трассируемость кода
Сообщите среди пользователей
Улучшите поиск кода в кодовой базе

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

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

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

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

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

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

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

Параметр	Описание
CommentStyle	Задайте стиль комментария многострочной или одной линии для сгенерированного кода C or C++.
Вставьте комментарии Polyspace	Задайте, вставить ли комментарии к коду для аннотаций блока Polyspace.

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

Примечание
Если у вас есть существующие файлы TLC с вручную вставленными комментариями для описаний блока, процесс генерации кода испускает эти комментарии вместо автоматически сгенерированных комментариев. Рассмотрите удаляющие существующие комментарии блока из своих файлов TLC. Вручную вставленные комментарии могут быть плохо отформатированы в сгенерированном коде, и трассируемость кода к модели не может работать.
Для виртуальных блоков или блоков, которые были удалены из-за сокращения блоков, комментарии не генерируются.
Когда вы конфигурируете генератор кода, чтобы произвести код, который включает комментарии, генератор кода включает текст для параметров модели, имен блока, имен сигнала и имен объектов Stateflow в комментариях сгенерированного кода. Если текст включает символы, которые не представлены в кодировании набора символов для модели, генератор кода заменяет символы на escape-последовательности XML. Например, генератор кода заменяет японскую полноширинную букву Katakana ア на escape-последовательность ア. Для получения дополнительной информации смотрите Интернационализацию и Генерацию кода.
Когда вы устанавливаете параметр конфигурации модели 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 как комментарий. Постоянное значение требует, чтобы преобразование типов совпадало с типом выходных данных.

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