Main Content

本页的翻译已过时。点击此处可查看最新英文版本。

使用说明和注释描述模型

您可以用说明和注释来描述您的模型,以帮助其他人理解它。通过输入文本、显示网站内容或从父级系统继承说明内容,可以向模型层次结构中的任何系统添加说明。对于每个系统,您也可以选择不显示任何说明。

注释是一种视觉元素,可用来为模型添加描述性说明和注解。您还可以添加可在点击后执行某种操作的注释。

文本注释可以包含以下任意组合:

  • 文本

  • 图像

  • 使用 LaTeX 和 MathML 命令的方程

  • 打开网站或执行 MATLAB® 函数的超链接

此外,您还可以创建仅包含图像的注释。

管理说明

要开始管理说明,请在 Modeling 选项卡的 Design 下,点击 Notes。如果模型有相关联的说明,它们会出现在模型右侧的窗格中。在层次结构中导航时,会显示每个系统的说明。如果模型没有说明,您可以添加说明。

说明存储在扩展名为 .mldatx 的文件中。如果您希望模型包含说明,请先创建说明文件。请参阅添加和编辑说明。创建该文件后,添加的说明会自动保存。

同一模型可以有多个相关联的说明文件,例如,分别针对具有不同角色的用户。此模型的使用者可以在与您的模型匹配的说明文件中选择合适的说明。说明文件包含模型名称和版本信息,以确保注释文件与模型匹配。

.mldatx 文件与模型分开保存。如果您将模型移至不同的文件夹,.mldatx 文件不会随之移动,但如果该文件位于 MATLAB 路径中,则仍保持关联。

读取和编辑模式

使用 Notes 窗格编辑和读取说明。使用 Read/Edit Notes 切换按钮 在模式中进行切换。当您点击 Edit Notes 时,编辑功能将启用。当您点击 Read Notes 时,编辑功能不可用。此时,内容以只读格式显示。当您在模型中导航时,Notes 窗格会更新为当前系统的内容。

添加和编辑说明

  1. 在模型的 Modeling 选项卡上的 Design 下,点击 Notes。说明界面出现在模型的右侧,并包含快速入门说明。

  2. 点击 Create a notes file 按钮。

  3. 输入说明文件的名称,或使用默认名称,然后点击 Save

  4. Notes 窗格处于编辑模式。您可以通过以下方式添加说明:

    • 在文本编辑器中输入文本。

    • 从菜单中,选择 Use URL for Notes,并输入您要将其内容显示为当前系统说明的 URL。

    • 导航到模型中的不同系统,并输入文本、使用 URL 或选择 Show Parent Notes

    • 选择 No Notes

  5. 完成添加和编辑后,点击 Read Notes 切换按钮 将说明置于读取模式。

在读取模式下,要进行编辑,请导航到您要编辑其内容的系统,然后点击 Edit Notes 切换按钮

管理注释

要创建文本注释,请使用以下选项之一:

  • 双击要创建注释的画布,然后从菜单中选择 Create Annotation

  • 点击 Simulink® Editor 选项板上的 注释框,然后点击画布。

  • 将 Simulink Editor 选项板上的注释框 拖到画布上。

  • 将文本从另一个应用程序拖到画布上。

  • 从剪贴板粘贴文本。右键点击画布并选择 Paste

添加文本注释后,您可以:

  • 对文本应用格式更改,或使用格式设置工具栏插入图像、表格或方程。

  • 使用上下文菜单中的 Paragraph 菜单应用其他格式设置。例如,您可以从此菜单中创建项目符号和编号列表。

  • 使用上下文菜单添加超链接。您可以使用超链接打开网站,或使用 MATLAB 命令使注释具有交互功能。

  • 使用 Property Inspector 应用属性。要查看 Property Inspector,请在 Modeling 选项卡中,在 Design 下,点击 Property Inspector

调整注释大小

当您输入内容时,注释会调整大小。您还可以通过拖动注释框的角部来调整注释大小。例如,您可以按住 Shift 键并拖动,从而按比例调整大小。

调整注释大小后,注释将一直保持该大小,而不管内容大小如何,直到您再次调整它为止。要还原注释的原始高度或宽度,请在 Property Inspector 中的 Appearance 下,清除 Fixed heightFixed width 复选框。

使注释具有交互功能

要使注释具有交互功能,可为文本注释的任何内容使用超链接。

  1. 在注释中,选择您希望具有交互功能的内容。要使整个注释具有交互功能,请选择所有内容。

  2. 右键点击并从上下文菜单中选择 Hyperlink

  3. 在 Hyperlink 对话框中,执行以下操作之一:

    • 选择 URL Address 作为目标,并在 Code 框中输入网址。

    • 选择 MATLAB Code 作为目标,并在 Code 框中输入 MATLAB 函数。

  4. 点击 OK

有关替代方法,请参阅注释回调函数

添加图像注释

当您要独立于文本调整图像大小或移动图像时,请创建图像注释。例如,您可以确定公司徽标的大小并将它放在模型中的特定位置。您还可以通过点击图像调用 MATLAB 函数。要添加包含图像的注释,请将图像从文件系统拖到画布上。

提示

要在每个新模型中都包含某个图像(例如徽标),请将该图像添加到默认模板中。请参阅Create Template from Model

您也可以将 Image 从选项板拖到画布上。然后,您可以执行以下任一操作:

  • 双击图像框并浏览到某个图像。

  • 从剪贴板粘贴图像。右键点击图像框,然后选择 Paste Image

  • 将图像从本地文件系统拖到 Simulink Editor 画布上。

提示

如果您调整了图像大小,可将其重置为原始大小。右键点击图像,然后选择 Format > Restore Size

要将某个操作与图像关联,请执行以下操作:

  1. 选择图像。

  2. 在 Property Inspector 中的 ClickFcn 下,添加点击图像时要调用的 MATLAB 函数。

在注释中添加方程

您可以通过点击注释格式设置工具栏中的 Insert Equation 按钮在注释中添加方程。

在 Edit Equation 对话框中,输入 LaTeX 或 MathML 代码以生成方程。有关 LaTeX 命令,请参阅插入 LaTeX 方程

要编辑方程代码,请双击注释中的方程。与注释中的文本类似,您可以使用格式设置工具栏格式化注释中的方程。您可以更改在注释中方程的字体颜色、文本突出显示颜色、字体大小和位置。

您可以将 TeX 格式设置命令添加到数学和其他符号以及希腊字母的注释中。

  1. 将支持的 TeX 命令添加到注释中。例如,添加以下文本:

    \sigma \kappa \mu
    
  2. 在已选中注释或文本光标在注释中的状态下,在 Property Inspector 中的 Appearance 下,选择 Enable TeX commands

    当您在注释外部点击时,TeX 命令在注释中显示为符号。

下表显示 Simulink 注释中支持的 TeX 字符。

支持的 TeX 字符

alpha

beta

gamma

delta

epsilon

zeta

eta

theta

vartheta

iota

kappa

lambda

mu

nu

xi

pi

rho

sigma

varsigma

tau

upsilon

phi

chi

psi

omega

Gamma

Delta

Theta

Lambda

Xi

Pi

Sigma

Upsilon

Phi

Psi

Omega

forall

exists

ast

cong

sim

leq

infty

clubsuit

diamondsuit

heartsuit

spadesuit

leftarrow

uparrow

rightarrow

downarrow

circ

pm

geq

propto

partial

bullet

div

neq

equiv

approx

aleph

Im

Re

otimes

oplus

oslash

cap

cup

supseteq

supset

subseteq

subset

int

in

o

copyright

0

ldots

varpi

times

cdot

vee

wedge

perp

mid

Leftarrow

Rightarrow

Uparrow

Downarrow

prime

nabla

surd

angle

neg

lceil

rceil

lfloor

rfloor

langle

rangle

将注释与模块和区域相关联

您可以在模型中的注释和模块或区域之间添加一条线。这些注释连接线在两端动态连接,以便它们根据需要移动和调整大小来保持连接。

  1. 将光标放在注释边框上要开始连接线的位置。

  2. 当光标是十字准线时,将连接线拖到要作为线条端点的模块或区域。

提示

要指定注释连接线的颜色或宽度,请右键点击连接线,然后使用 Format 菜单进行设置。

隐藏注释

默认情况下,所有注释都会显示在模型中。要隐藏注释,首先通过将其转换为标记来配置为隐藏。然后,在 Format 选项卡中,点击 Show Markup

您可以配置注释,以便隐藏或显示它。

  1. 右键点击注释。

  2. 从上下文菜单中,选择 Convert to Markup

无论您设置的背景颜色是什么,标记注释都具有浅蓝色背景。如果将标记注释改回常规注释,注释将恢复使用您设置的背景颜色。

要将标记注释更改为常规注释(无法隐藏的注释),请从注释上下文菜单中选择 Convert to Annotation

要隐藏所有标记注释,请在 Format 选项卡中,点击 Show Markup

要显示隐藏的标记注释,请在 Format 选项卡中,点击 Show Markup

注意

在模型引用层次结构中,Show MarkupHide Markup 仅应用于当前模型引用级别。

注释回调函数

您可以将下列回调函数与注释相关联。

点击函数.  您可以使用链接使注释支持交互。您也可以通过添加点击函数回调使注释支持交互。点击函数是点击注释时 Simulink 调用的 MATLAB 函数。

您可以通过编程方式或交互方式添加点击函数回调。要以编程方式创建点击函数,请参阅 Simulink.Annotation。要以交互方式创建点击函数,请参阅将点击函数与注释相关联

与点击函数相关联的注释文本以蓝色显示。

加载函数.  Simulink 加载包含相关联注释的模型时,会调用加载函数。要将加载函数与注释相关联,请将注释的 LoadFcn 属性设置为所需函数(请参阅 Simulink.Annotation)。

删除函数.  在删除注释之前会调用删除函数。要将删除函数与注释相关联,请将注释的 DeleteFcn 属性设置为所需函数(请参阅 Simulink.Annotation)。

将点击函数与注释相关联.  您可以通过交互方式将点击函数与注释相关联。

  1. 添加注释。

  2. 打开 Annotation Properties 对话框。右键点击注释并选择 Properties

  3. 打开 ClickFcn 选项卡。在 ClickFcn 下的文本框中,输入定义点击函数的 MATLAB 代码,然后点击 OK

提示

您也可以使用注释文本作为点击函数。然后,在 Annotation Properties 对话框中,选中 Use annotation text as click callback 复选框。

选择和编辑点击函数注释.   如果您将注释与点击函数相关联,则点击会调用该函数,而不是选择注释。要选择注释,请在其周围拖出一个选择框。要编辑注释,请右键点击它并选择 Edit TextProperties

另请参阅

相关主题