DocBlock

创建记录模型的文本，并将文本与模型一起保存

库:
Simulink /模型范围实用程序
HDL编码器/模型范围实用程序

描述

的DocBlock允许您创建和编辑记录模型的文本，并将该文本与模型一起保存。双击该块的实例将创建一个包含与此块相关的文本的临时文件，并在编辑器中打开该文件。使用编辑器修改文本并保存文件。动态仿真模块^®软件将保存的文件的内容存储在模型文件中。

的DocBlock支持HTML、RTF (Rich Text Format)和ASCII文本文档类型。这些不同文档类型的默认编辑器是

HTML——微软^®词(如果可用)。否则,DocBlock控件上指定的编辑器打开HTML文档编辑/调试器首选项窗格中的“首选项”对话框。
RTF - Microsoft Word(如果可用)。否则,DocBlock控件上指定的编辑器打开RTF文档编辑/调试器首选项窗格中的“首选项”对话框。
文本- - -DocBlock控件上指定的编辑器打开文本文档编辑/调试器首选项窗格中的“首选项”对话框。

使用docblock命令更改默认编辑器。

提示

控件的块参数DocBlock，右键单击块图标并选择掩码>掩码参数说明…．

参数

全部展开

`代码生成模板符号`-生成代码的模板符号
`' '`|`摘要`|`描述`|`历史`|`修改历史`|`笔记`

在此字段中输入模板符号名称。嵌入式编码器^®软件使用这个符号向由模型生成的代码添加注释。有关更多信息，请参见在生成的代码中添加全局注释(嵌入式编码)．

依赖关系

要使注释出现在生成的代码中，还必须设置文档类型来文本．

编程使用

块参数:ECoderFlag

类型:特征向量

价值观:摘要|描述|历史|修改的历史|注释

默认值:' 0 '

`文档类型`-文件类型
`文本`(默认)|`RTF`|`超文本标记语言`

类关联的文档类型DocBlock．的选项是:

文本
RTF
超文本标记语言

依赖关系

如果你正在使用DocBlock要在代码生成期间向代码添加注释，请确保您设置了文档类型作为文本．如果你设置文档类型作为RTF或超文本标记语言，您的注释将不会出现在代码中。

编程使用

块参数:DocumentType

类型:特征向量

价值观:文本| RTF | HTML

默认值:“文本”

模型的例子

在DocBlock中捕获度量描述

使用DocBlock来捕获关于模型的信息。

开放模式

块特征

数据类型
直接引线	`没有`
多维信号	`没有`
适应信号	`没有`
讨论二阶导数过零检测	`没有`

扩展功能

C / c++代码生成
使用Simulink®Coder™生成C和c++代码。

使用为嵌入式编码器标志块参数指定的模板符号向生成的代码添加注释。需要嵌入式编码器许可证。有关更多信息，请参见使用Simulink DocBlock添加注释(嵌入式编码)．

HDL代码生成
使用HDL Coder™为FPGA和ASIC设计生成Verilog和VHDL代码。

HDL Coder™提供了影响HDL实现和合成逻辑的额外配置选项。另请参阅生成带有注释或注释的代码(高密度脂蛋白编码器)而且使用DocBlock集成自定义HDL代码(高密度脂蛋白编码器)．

高密度脂蛋白架构

体系结构	描述
`注释`(默认)	在生成的代码中插入文本作为注释。
`HDLText`	集成文本作为自定义HDL代码。
`没有高密度脂蛋白`	不要为这个块生成HDL代码。

高密度脂蛋白块属性

ConstrainedOutputPipeline	通过在设计中移动现有的延迟来放置在输出上的寄存器数量。分布式管道不会重新分发这些寄存器。默认值是`0`．有关更多细节，请参见ConstrainedOutputPipeline(高密度脂蛋白编码器)．
InputPipeline	要在生成的代码中插入的输入管道阶段的数量。分布式流水和约束输出流水可以移动这些寄存器。默认值是`0`．有关更多细节，请参见InputPipeline(高密度脂蛋白编码器)．
OutputPipeline	要在生成的代码中插入的输出管道阶段的数量。分布式流水和约束输出流水可以移动这些寄存器。默认值是`0`．有关更多细节，请参见OutputPipeline(高密度脂蛋白编码器)．
开发	文字的语言，要么Verilog^®或硬件描述语言(VHDL)^®．默认是VHDL。当体系结构是`HDLText`，此属性可用。要了解更多，请参见使用DocBlock集成自定义HDL代码(高密度脂蛋白编码器)．

限制

文档类型必须文本．
HDL Coder不支持超文本标记语言或RTF选项。
你最多可以有两个DocBlock块与体系结构设置为HDLText在同一个子系统中。
如果你有两个DocBlock一个人必须有积木开发设置为硬件描述语言(VHDL)，而另一个肯定是开发设置为Verilog．生成代码时，HDL Coder只集成自定义代码DocBlock匹配代码生成的目标语言。

PLC的代码生成
使用Simulink®PLC Coder™生成结构化文本代码。

版本历史

之前介绍过的R2006a

另请参阅

模型信息|docblock

主题

在生成的代码中添加全局注释(嵌入式编码)

DocBlock

描述

参数

代码生成模板符号-生成代码的模板符号' '|摘要|描述|历史|修改历史|笔记

依赖关系

编程使用

文档类型-文件类型文本(默认)|RTF|超文本标记语言

依赖关系

编程使用

模型的例子

在DocBlock中捕获度量描述

块特征

扩展功能

C / c++代码生成使用Simulink®Coder™生成C和c++代码。

HDL代码生成使用HDL Coder™为FPGA和ASIC设计生成Verilog和VHDL代码。

PLC的代码生成使用Simulink®PLC Coder™生成结构化文本代码。

版本历史

另请参阅

主题

`代码生成模板符号`-生成代码的模板符号
`' '`|`摘要`|`描述`|`历史`|`修改历史`|`笔记`

`文档类型`-文件类型
`文本`(默认)|`RTF`|`超文本标记语言`

C / c++代码生成
使用Simulink®Coder™生成C和c++代码。

HDL代码生成
使用HDL Coder™为FPGA和ASIC设计生成Verilog和VHDL代码。

PLC的代码生成
使用Simulink®PLC Coder™生成结构化文本代码。