Exponenta Banner

DocBlock

Создайте текст, что модель документов и сохранила текст с моделью

расширьте все на странице
  • Библиотека:

  • Simulink / Утилиты Всей модели

    HDL Coder / Утилиты Всей модели

Описание

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

DocBlock поддерживает HTML, Формат Rich Text Format (RTF) и типы документа текста ASCII. Редакторы по умолчанию для этих различных типов документа

  • HTML — Microsoft® Word (при наличии). В противном случае DocBlock открывает документы HTML с помощью редактора, заданного на панели Editor/Debugger Preferences диалогового окна Preferences.

  • RTF — Microsoft Word (при наличии). В противном случае DocBlock открывает документы RTF с помощью редактора, заданного на панели Editor/Debugger Preferences диалогового окна Preferences.

  • Текст — DocBlock открывает текстовые документы с помощью редактора, заданного на панели Editor/Debugger Preferences диалогового окна Preferences.

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

Совет

Чтобы отредактировать параметры блоков DocBlock, щелкните правой кнопкой по значку блока и выберите Mask > Mask Parameters....

Параметры

развернуть все

Введите имя символа шаблона в этом поле. Программное обеспечение Embedded Coder® использует этот символ, чтобы добавить комментарии в код, сгенерированный из модели. Для получения дополнительной информации смотрите, Добавляют Глобальные Комментарии (Embedded Coder).

Зависимости

Для комментариев, чтобы появиться в сгенерированном коде, необходимо также установить Document type на Text.

Программируемое использование

Параметры блоков: ECoderFlag
Ввод: символьный вектор
Значения: Abstract | Description | History | Modified History | Notes
Значение по умолчанию: '0'

Выберите тип документа, сопоставленного с DocBlock. Опции:

  • Text

  • RTF

  • HTML

Зависимости

Если вы используете DocBlock, чтобы добавить комментарии в ваш код во время генерации кода, гарантировать, что вы устанавливаете Document Type как Text. Если вы установите Document Type как RTF или HTML, ваши комментарии не появятся в коде.

Программируемое использование

Параметры блоков: DocumentType
Ввод: символьный вектор
Значения: Text | RTF | HTML
Значение по умолчанию: 'Text'

Образцовые примеры

Capture Measurement Descriptions in a DocBlock

Получите описания измерения в DocBlock

Используйте DocBlock, чтобы получить информацию о модели.

Открытый пример

Характеристики блока

Типы данных

Прямое сквозное соединение

no

Многомерные сигналы

no

Сигналы переменного размера

no

Обнаружение пересечения нулем

no

Расширенные возможности

Генерация кода PLC
Сгенерируйте код Структурированного текста с помощью Simulink® PLC Coder™.

Смотрите также

|

Темы

Представлено до R2006a

Документация Simulink
Поддержка