Exponenta Banner

DocBlock

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

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

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

Описание

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

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

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

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

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

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

Совет

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

Параметры

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

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

Зависимости

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

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

Блочный параметр: ECoderFlag
Ввод: символьный вектор
Значения: Краткий обзор | описание | история | измененная история | примечания
Значение по умолчанию: '0'

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

  • Текст

  • RTF

  • HTML

Зависимости

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

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

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

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

Capture Measurement Descriptions in a DocBlock

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

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

Блокируйте характеристики

Типы данных

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

No

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

No

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

No

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

No

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

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

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

|

Темы

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

Была ли эта тема полезной?
Документация Simulink
Поддержка