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

Эти примеры показывают, как добавить глобальный комментарий к Simulink^® моделировать так, чтобы текст комментария появился в сгенерированном файле или файлах. Задайте имя символа шаблона с DocBlock Simulink, аннотацией Simulink или Stateflow^® примечание. Можно также использовать возможность сортировки заметок, которая работает с аннотациями Simulink или примечаниями Stateflow, но не DocBlock s. Для получения дополнительной информации о символах шаблона см. Раздел «Символы и правила шаблона».

Примечание

Имена символов шаблона Description и Model Information являются полями в диалоговом окне Property Inspector. Если вы используете одно из этих имен символов для глобального комментария, и в его Property Inspector полях также есть текст, оба имени появляются в сгенерированных файлах.

Используйте Simulink DocBlock, чтобы добавить комментарий

Откройте модель Simulink.

model='rtwdemo_codetemplate';
open_system(model)

В разделе Параметров конфигурации установите Code templates значение rtwdemocodetemplate.cgt. Этот шаблон кода содержит необходимые индивидуальные настройки для создания глобальных комментариев.
Щелкните правой кнопкой мыши по DocBlock и выберите Mask > Mask Parameters.
В Code generation template symbol поле введите одно из следующих значений:
- Abstract
- Description
- History
- Notes
Нажмите OK. Имена символов шаблона чувствительны к регистру.
Если вы используете DocBlock, чтобы добавить комментарии к коду, установите для Document type значение Text. Если вы задаете Document type RTF или HTMLваши комментарии не отображаются в коде.
В диалоговом окне Свойств блока» на вкладке «Block Annotation» выберите %<ECoderFlag> и нажмите OK. Имя символа, введенное вами на предыдущем шаге, теперь появляется под DocBlock в модели.
Сохраните модель. После генерации кода генератор кода помещает комментарий в каждый сгенерированный файл, шаблон которого имеет назначенное имя символа. Генератор кода помещает комментарий в сгенерированный файл в месте, которое соответствует месту, где имя символа расположено в файле шаблона.
Соответствующий фрагмент из сгенерированного файла для этой модели является:
```
	 *
	 * ABSTRACT:
	 * This text maps to the code template %<Abstract> symbol.
```
Чтобы добавить дополнительные комментарии к сгенерированным файлам, повторите шаги 2-6.

Используйте аннотацию Simulink, чтобы добавить комментарий

Откройте модель rtwdemo_codetemplate.
Дважды кликните незанятую область на модели, где вы хотите разместить комментарий. См. «Описание моделей с использованием примечаний и аннотаций».
Тип <S:Symbol_name> далее следует комментарий. Symbol_name является одним из следующих:
- Abstract
- Description
- History
- Notes
Для примера введите <S:Description>This is the description I want. Имена символов шаблона чувствительны к регистру. Если вы хотите, чтобы генератор кода отсортировал несколько комментариев для Notes имя символа, замените следующий шаг на Использование отсортированных примечаний для добавления комментариев.
Щелкните вне прямоугольника аннотации и сохраните модель. После генерации кода генератор кода помещает комментарий в каждый сгенерированный файл, шаблон которого имеет назначенное имя символа. Генератор кода помещает комментарий в сгенерированный файл в месте, которое соответствует месту, где имя символа расположено в файле шаблона. Если вы хотите, чтобы генератор кода отсортировал несколько комментариев для Notes имя символа, замените следующий шаг на Использование отсортированных примечаний для добавления комментариев.
Чтобы добавить один или несколько других комментариев к сгенерированным файлам, повторите шаги 2-4.

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

Функция отсортированных заметок позволяет добавлять отсортированные комментарии к сгенерированным файлам. Генератор кода помещает эти комментарии в каждый сгенерированный файл в месте, которое соответствует месту Notes символ расположен в файле шаблона.

Генератор кода использует этот порядок сортировки:

Цифры перед буквами.
Среди чисел нуль помещается первым.
Среди букв прописные буквы помещаются перед строчными буквами.

Можно использовать отсортированные заметки для аннотации Simulink или заметки Stateflow, но не с DocBlock.

В аннотации Simulink или примечании Stateflow введите <S:NoteY> далее следует первый комментарий. Y - это число или буква.
Повторите этот процесс для требуемого количества дополнительных комментариев. Замените Y с последующим номером или буквой.

Этот рисунок иллюстрирует отсортированные заметки на модели. Он показывает, где генератор кода помещает каждую заметку в сгенерированный файл.

Соответствующий фрагмент из сгенерированного файла для этой модели является:

	 *
	 * NOTES:
	 * Note: This Simulink annotation maps to the code template %<Note> symbol.
	 * Note1: Another Simulink annotation .
	 *

Ограничения

Вы не можете сгенерировать глобальные комментарии с помощью имен символов шаблона внутри DocBlock Simulink, когда Language для генерации кода C++.

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