Main Content

DocBlock

创建用以说明模型的文本并随模型保存文本

  • 库:
  • Simulink / Model-Wide Utilities

    HDL Coder / Model-Wide Utilities

  • DocBlock

描述

DocBlock 允许您创建和编辑用于说明模型的文本,并随模型保存文本。双击该模块的实例将创建一个包含与此模块关联的文本的临时文件并在编辑器中打开该文件。使用编辑器修改文本并保存文件。Simulink® 软件会将所保存文件的内容存储在模型文件中。

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

  • HTML - Microsoft® Word(如果可用)。否则,DocBlock 将使用“预设项”对话框的编辑器/调试器预设项窗格中指定的编辑器打开 HTML 文档。

  • RTF - Microsoft Word(如果可用)。否则,DocBlock 将使用“预设项”对话框的编辑器/调试器预设项窗格中指定的编辑器打开 RTF 文档。

  • 文本 - DocBlock 将使用“预设项”对话框的编辑器/调试器预设项窗格中指定的编辑器打开文本文档。

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

提示

要编辑 DocBlock 的模块参数,请右键点击模块图标,然后选择封装 > 封装参数...

参数

全部展开

在此字段中输入模板符号名称。Embedded Coder® 软件使用此符号将注释添加到从模型生成的代码中。有关详细信息,请参阅 Add Global Comments in the Generated Code (Embedded Coder)

依存关系

要使注释显示在生成的代码中,还必须将文档类型设置为“文本”。

编程用法

模块参数ECoderFlag
类型:字符向量
值:Abstract | Description | History | Modified History | Notes
默认值:'0'

选择与 DocBlock 关联的文档的类型。选项包括:

  • 文本

  • RTF

  • HTML

依存关系

如果您在代码生成过程中使用 DocBlock 向代码添加注释,请确保将文档类型设置为“文本”。如果您将文档类型设置为 “RTF” 或 “HTML”,则您的注释不会出现在代码中。

编程用法

模块参数DocumentType
类型:字符向量
Text | RTF | HTML
默认值:'Text'

模块特性

数据类型

直接馈通

多维信号

可变大小信号

过零检测

扩展功能

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

版本历史记录

在 R2006a 之前推出