DocBlock

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

Библиотека:
Утилиты Simulink/Model
HDL-кодер/общемодельные утилиты

Описание

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

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

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

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

Совет

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

Параметры

расширить все

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

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

Зависимости

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

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

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

Тип: Вектор символов

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

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

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

Выберите тип документа, связанный с 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`

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

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

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

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

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

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

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

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

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

Ограничения

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

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

См. также

docblock | Model Info

Темы

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

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

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

DocBlock

Описание

Параметры

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

Зависимости

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

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

Зависимости

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

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

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

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

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

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

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

Генерация кода ПЛК
Сгенерируйте структурированный текстовый код с помощью 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++ с помощью Coder™ Simulink ®

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

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

См. также

Темы

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

Поддержка

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

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

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

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

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