关于为Simulink模型添加注解的五种方式分析和介绍

您是否有过这样的经历：当打开旧版本的 Simulink 模型或某个同事开发的模型时完全搞不清如何使用？在这种情况下，添加恰当的注解会非常有帮助。

本文将使用图 1 所示的 Simulink 汽车模型来演示 5 种为 Simulink 模型添加注解的方法（分为上下两篇），包括：

指定和显示模型信息

为模型添加注释

为模块和信号加注解

向模型层添加备注

为总线、信号和参数添加注解

图1. Simulink 中完整的汽车模型。

学习资源

指定和显示模型信息

第一步是创建高级描述。您可以在 Property Inspector（属性查看）中或者右键单击画布并选择 Model Properties（模型属性）查看和编辑模型的 Description （描述）属性。若要查看模型描述，请在MATLAB 命令提示中（图2，左上角）输入 help，然后再输入模型名称。

图 2. Model Properties 对话框，显示模型描述（左）和历史信息（右）。

Property Inspector（属性查看）中的 Info（信息）选项卡和 Model Properties（模型属性）对话框（图2，右侧）中的 History（历史）选项卡还汇总了模型历史信息，包括变动、版本和上次保存的日期。

模型描述和模型属性也可以从模型中查看。使用 Model Info（模型信息）模模块指定要显示的属性（图3）。

图 3. 显示模型属性的 Model Info（模型信息）模块。

为模型添加注释

添加注释是另一种提升设计可读性和清晰度的方式。注释是快速添加描述性备注和标注的视觉元素。使用选项板或者双击画布并选择 Create Annotation（创建注释），可创建文本、图像、方程、网站链接或 MATLAB 函数链接的组合。您可以修改注释的类型和外观；例如，您可以在 LaTeX 或 MathML 中添加数学方程式。

通过将光标放在注释轮廓上并将连接线拖动到目标模块上，可以在注释和模块之间添加连接线。通过使用选项板或在感兴趣的区域周围拖动一个框并从操作栏中选择 Create Area(创建区域)，可以将模型中的各区域框起来，以直观地对相关模模块进行分组并提高模型的可读性。可以标记区域以指示模模块之间的关系。

图 4 说明了这些注释技术。

图 4. 添加了注释的模型。

为模块和信号加注解

随着设计的进展，您可能会发现自己要处理数百甚至数千个模块和信号，这使得模型更加不易阅读。

通过命名信号和模块，可以立即提高设计的清晰度（图 5）。右键单击该信号并选择 Properties（属性），或者只需双击该信号即可输入或编辑信号名称。单击模块正下方的默认名称即可命名该模块。

图 5. 添加注释的模块和信号。

使用模块或信号属性中的相应字段输入模块或信号的描述。随后，您可以在模块图标下方或在模块上方悬停时显示描述和其他模块属性。带注释的模块和信号如图5所示。您还可以将模块描述作为注释包含在从模型生成的 C/C++ 代码中。

如果使用封装技术创建模块的自定义接口，用户仍然可以在 Mask Editor 的 Documentation（文档）窗格中提供描述（图 6）。同一窗格中的 Help（帮助）字段可以让您输入所需信息，该信息会在用户单击封装模块对话框的 Help（帮助）按钮时显示。

图6. 屏蔽模块的注解。

将在下篇中介绍向模型层添加备注以及为总线、信号和参数添加注解的方法。