DocBlock

Создание текста, документирующего модель, и сохранение текста с моделью

Библиотека:
Утилиты Simulink/для всей модели
Кодер HDL/утилиты для всей модели

Описание

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

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

HTML - Microsoft ® Word (если доступно). В противном случае DocBlock открывает HTML-документы с помощью редактора, указанного на панели «Установки редактора/отладчика» диалогового окна «Установки».
RTF - Microsoft Word (если доступно). В противном случае DocBlock открывает RTF-документы с помощью редактора, указанного на панели «Установки редактора/отладчика» диалогового окна «Установки».
Текст - DocBlock открывает текстовые документы с помощью редактора, указанного на панели «Установки редактора/отладчика» диалогового окна «Установки».

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

Совет

Чтобы изменить параметры блока DocBlock, щелкните правой кнопкой мыши значок блока и выберите «Маска» > «Параметры маски»....

Параметры

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

`Code generation template symbol` - Символ шаблона для сгенерированного кода
`' '` | `Abstract` | `Description` | `History` | `Modified History` | `Notes`

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

Зависимости

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

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

Параметр блока: ECoderFlag

Текст: символьный вектор

Значения: Abstract | Description | History | Modified History | Notes

По умолчанию: '0'

`Document type` - Тип документа
`Text` (по умолчанию) | `RTF` | `HTML`

Выберите тип документа, связанного с DocBlock. Возможны следующие варианты:

Text
RTF
HTML

Зависимости

При использовании DocBlock для добавления комментариев к коду во время создания кода необходимо установить тип документа как Text. При установке типа документа как RTF или HTML, ваши комментарии не будут отображаться в коде.

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

Параметр блока: DocumentType

Текст: символьный вектор

Значения: Text | RTF | HTML

По умолчанию: 'Text'

Примеры модели

Capture Measurement Descriptions in a DocBlock

Захват описаний измерений в DocBlock

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

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

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

Типы данных
Прямой проход	`no`
Многомерные сигналы	`no`
Сигналы переменного размера	`no`
Обнаружение пересечения нулей	`no`

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

Создание кода C/C + +
Создайте код C и C++ с помощью Simulink ® Coder™

Для добавления комментариев к сгенерированному коду используется символ шаблона, заданный для параметра блока «Флаг встроенного кодера». Требуется лицензия Embedded Coder. Дополнительные сведения см. в разделе Использование Simulink DocBlock для добавления комментария (встроенный кодер).

Создание кода HDL
Создание кода Verilog и VHDL для проектов FPGA и ASIC с использованием Coder™ HDL.

HDL Coder™ предоставляет дополнительные опции конфигурации, которые влияют на реализацию HDL и синтезированную логику. См. также разделы Создание кода с аннотациями или комментариями (кодер HDL) и Интеграция пользовательского кода HDL с помощью DocBlock (кодер HDL).

Архитектура HDL

Архитектура	Описание
`Annotation` (по умолчанию)	Вставка текста в качестве комментария в созданный код.
`HDLText`	Интеграция текста в качестве пользовательского кода HDL.
`No HDL`	Не создавайте код HDL для этого блока.

Свойства блока HDL

ConstrainedOutputPipeline	Количество регистров для размещения на выходах путем перемещения существующих задержек в рамках проекта. Распределенная конвейерная обработка не перераспределяет эти регистры. Значение по умолчанию: `0`. Дополнительные сведения см. в разделе ConstrainedOutputPipeline (кодер HDL).
InputPipeline	Количество входных ступеней трубопровода для вставки в сформированный код. Распределенная конвейерная обработка и конвейерная обработка с ограниченным выходом могут перемещать эти регистры. Значение по умолчанию: `0`. Дополнительные сведения см. в разделе InputPipeline (кодер HDL).
OutputPipeline	Количество выходных ступеней трубопровода для вставки в сформированный код. Распределенная конвейерная обработка и конвейерная обработка с ограниченным выходом могут перемещать эти регистры. Значение по умолчанию: `0`. Дополнительные сведения см. в разделе Выходной конвейер (кодер HDL).
TargetLanguage	Язык текста, Verilog ® или ^VHDL ®. По умолчанию используется VHDL. Когда архитектура `HDLText`, это свойство доступно. Дополнительные сведения см. в разделе Интеграция пользовательского кода HDL с помощью DocBlock (HDL Coder).

Ограничения

Тип документа должен быть Text.
Кодер HDL не поддерживает HTML или RTF варианты.
Можно установить максимум два блока DocBlock с архитектурой HDLText в той же подсистеме.
Если имеется два блока DocBlock, для одного из них должен быть установлен TargetLanguage VHDL, а другой должен иметь значение TargetLanguage Verilog. При создании кода кодер HDL интегрирует только пользовательский код из DocBlock, соответствующий целевому языку для создания кода.

Создание кода ПЛК
Создание структурированного текстового кода с помощью Coder™ Simulink ® PLC

См. также

docblock | Сведения о модели

Темы

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

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

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

DocBlock

Описание

Параметры

`Code generation template symbol` - Символ шаблона для сгенерированного кода
`' '` | `Abstract` | `Description` | `History` | `Modified History` | `Notes`

Зависимости

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

`Document type` - Тип документа
`Text` (по умолчанию) | `RTF` | `HTML`

Зависимости

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

Примеры модели

Захват описаний измерений в DocBlock

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

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

Создание кода C/C + +
Создайте код C и C++ с помощью Simulink ® Coder™

Создание кода HDL
Создание кода Verilog и VHDL для проектов FPGA и ASIC с использованием Coder™ HDL.

Создание кода ПЛК
Создание структурированного текстового кода с помощью Coder™ Simulink ® PLC

См. также

Темы

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

Поддержка

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

DocBlock

Описание

Параметры

Code generation template symbol - Символ шаблона для сгенерированного кода ' ' | Abstract | Description | History | Modified History | Notes

Зависимости

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

Document type - Тип документа Text (по умолчанию) | RTF | HTML

Зависимости

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

Примеры модели

Захват описаний измерений в DocBlock

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

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

Создание кода C/C + + Создайте код C и C++ с помощью Simulink ® Coder™

Создание кода HDL Создание кода Verilog и VHDL для проектов FPGA и ASIC с использованием Coder™ HDL.

Создание кода ПЛК Создание структурированного текстового кода с помощью Coder™ Simulink ® PLC

См. также

Темы

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

Поддержка

`Code generation template symbol` - Символ шаблона для сгенерированного кода
`' '` | `Abstract` | `Description` | `History` | `Modified History` | `Notes`

`Document type` - Тип документа
`Text` (по умолчанию) | `RTF` | `HTML`

Создание кода C/C + +
Создайте код C и C++ с помощью Simulink ® Coder™

Создание кода HDL
Создание кода Verilog и VHDL для проектов FPGA и ASIC с использованием Coder™ HDL.

Создание кода ПЛК
Создание структурированного текстового кода с помощью Coder™ Simulink ® PLC