你打开过旧的Simulink吗万博1manbetx®是一个模型，还是一个同事开发的模型，而你却不知道它是如何工作的?在这种情况下，适当的文档非常有用。它还可以提高你的生产力和促进跨团队合作。
有许多不同的方法来记录Simulink模型。万博1manbetx本文将指导您到五种选项，从高级模型说明和快速画布笔记到更详细的模型和块文档。为了说明每种方法，我们将使用图1中所示的Simulink车辆模型。万博1manbetx
图1所示。一个完整的车辆模型在Simulink。万博1manbetx
指定和显示模型信息
您可能想要采取的第一个动作是提供高级描述。您可以在“属性检查器视图”（图2）中查看和编辑模型的描述属性，或右键单击画布和选择模型属性．要查看模型描述，输入帮助然后是Matlab的模型名称®命令提示符。
图2.显示模型描述的属性检查器视图。
属性检查器中的Info选项卡还总结了模型历史，包括修改、版本和最后保存日期。
注释的模型
添加注释是另一种提高您设计可读性和清晰度的方法。注释是可允许您快速添加描述性备注和标注的可视元素。使用调色板或双击画布并选择创建注释创建任何文本，图像，公式和链接到网站或MATLAB的组合®职能。您可以修改注释的类型和外观;例如，你可以在LaTeX或MathML中添加数学方程式．
您可以将光标放在注释大纲上，并将连接线拖动到所需的块，从而在注释和块之间添加连接线。您可以将模型的区域框起来，以可视化地对相关块进行分组，并通过使用调色板或在感兴趣的区域周围拖动框并进行选择来提高模型的可读性创建区域从操作栏。区域可以被标记以表明块之间的关系。
图3说明了这些注释技术。
图3.添加了注释的型号。
记录块和信号
随着设计的进行，您可能会发现自己要处理数百甚至数千个块和信号，使模型更加难以阅读。
通过命名信号和块，可以立即提高设计的清晰度(图4)。要输入或编辑信号名称，右键单击信号并选择属性或者只需双击信号。要命名块，请单击块下方的默认名称。
学习更多关于控制块的格式、样式和外观。
图4.带注释的块和信号。
使用块或信号属性中的相应字段输入块或信号的描述。那么你可以显示描述和其他块属性在块图标下方或悬停在块上时。带注释的块和信号如图4所示。你也可以将块描述包含为评论在模型生成的C / C ++代码中。
如果你用面具来定义自定义接口块,你仍然可以提供一个描述文档窗格面具的编辑器(图5)。帮助字段在同一面板允许您输入信息,你想当蒙面块面具上的用户单击帮助按钮对话框。
图5。屏蔽块的文档。
向模型层添加注释
随着模型变得更大，层次结构将更多的层添加到层次结构中，使得难以捕获完整的图片。您可以使用Viplmark，Notes和DocBlock注释型号的各个层。
查看模型的书签部分 - 您可以使用它们直接导航到模型的特定部分，并提供特定视图的详细信息或注释。要创建视图，请选择Viewmark这种观点按钮来自您想要捕获的模型部件的面板。单击viplmarks.按钮查看和添加视图的描述或注释（图6）。
图6。视图标记详细描述模型的特定视图。
要在模型层次结构中的任何图层中添加注释，首先需要创建一个注释文件。注意可以包括图像和链接以及URL（图7）。如果模型已有与其关联的注释，则在导航层次结构时，Notes窗格显示当前图层的内容。
图7。说明详细描述了模型层次结构中的特定层。
DocBlock为您提供另一种添加笔记的方法。双击块的实例创建包含与此块关联的文本的临时文件，并在编辑器中打开文件（图8）。注意你可以使用DocBlock中的注释文本作为全局注释它出现在从模型生成的代码中。
图8.添加了评论的DocBlock。
记录总线，信号和参数
Si万博1manbetxmulink模型通常依赖于存储在模型外部的变量和数据—例如，总线、信号和参数对象通常存储在基本工作空间中。可以使用对象的Description属性详细描述对象的角色和功能。这可以通过编程方式实现:
>> myparam = 万博1manbetxsimulink.parameter;myparam.description ='这是参数描述';
或者从相应的对话框中，可从模型资源管理器或双击对象访问（图9）。
图9.总线，信号和参数对象的描述字段。
如果您正在使用嵌入式编码器®为了从模型生成代码，您可以在生成的代码中添加总线、信号和参数对象描述作为变量声明的注释(图10)。
图10。在生成的代码中使用总线、参数和信号对象描述字段作为注释。
学习更多关于在生成的代码中插入Simulink数据对象的描述作为万博1manbetx注释和向生成的代码添加自定义注释．
下一步
此时，您可能会想知道，如果我的项目包括多个Simulink模型，该怎么办？万博1manbetx是否有方法可以扩展到整个项目？项目和产品一s manbetx 845样万博1manbetx仿真软件报告生成器™和万博1manbetx仿真软件需求™为本文中讨论的技术提供自然的扩展。
使用Sim万博1manbetxulink Report Generator，您可以设计和自动生成常见格式的模型报告，如PDF, Microsoft®单词®微软演示文稿®和HTML。
万博1manbetxSimulink要求允许您创建丰富的文本要求并将其链接到设计，代码和测试。您可以检查所需的执行和验证状态，使您能够评估项目完整性。
项目可以帮助你组织项目，促进高效的团队合作和个人生产力。您可以在一个地方管理所有的项目文件，查看和标记文件以进行同行评审工作流程，并使用外部源代码控制工具(如Subversion)跟踪和共享您的项目®或git™。
