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