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....

Параметры

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

`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++ с помощью Simulink® Coder™.

Использует символ шаблона, который вы задаете для параметров блоков Флага Embedded Coder, чтобы добавить комментарии в сгенерированный код. Требует лицензии 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-код для этого блока.

Свойства блока 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, который совпадает с выходным языком для генерации кода.

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

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

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++ с помощью Simulink® Coder™.

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

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

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

Темы

Документация 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 с помощью HDL Coder™.

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

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

Темы

Документация 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 с помощью HDL Coder™.

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