您是否有过这样的经历:当打开旧版本的 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. 屏蔽模块的注解。
将在下篇中介绍向模型层添加备注以及为总线、信号和参数添加注解的方法。
电路设计参考图
讲不出再见!华为Mate7已经降到无人问津
可以用什么标准来描述不同类型的数字人类
CSS框架:Semantic UI的优缺点
伺服电机如何进行快速的测试?
关于为Simulink模型添加注解的五种方式分析和介绍
微软封禁员工讨论OpenAI DALL-E 3模型漏洞
适合新手使用的5款超简单电路图制作软件
苹果春季发布会定于3月23日举行,但不会发布AirPods3
NVIDIA RTX 3080库存不足或不足
荣耀9发布会即将开始:荣耀9发布会视频直播链接地址先知道,和胡歌一起见证华为荣耀9
继电器根据工作原理和结构类型可分为哪几种
比亚迪回应“广告门”事件,因补贴政策变化而一季度利润骤降83%
四大主流无线充电标准发展趋势及市场优缺点
基于粗糙集联合决策树法的智能变电站远程调度管理优化
称重传感器的工作原理以及分类的介绍
“虚假打卡”层出不绝,企业应该如何应对这种情况?
进口罗德与施瓦茨FSU8频谱分析仪8GHz
达利凯普成功上市,深耕射频微波MLCC领域
爱立信在全球斩获122个5G商用合同,2026年5G签约用户将达到35亿