添加全局注释
下面的示例演示如何向Simulink添加全局注释万博1manbetx®建模,以便注释文本出现在生成的文件或您想要的文件中。使用Simulink指定模板符号名万博1manbetxDocBlock、Sim万博1manbetxulink注释或状态流®请注意。您还可以使用与Simulink注释或Stateflow注释一起工作的排序注释功能(但不是万博1manbetxDocBlocks).有关模板符号的更多信息,请参见模板符号和规则.
请注意
模板符号名称描述
而且ModifiedHistory
“模型属性”对话框中的字段也是。如果您使用这些符号名称中的一个作为全局注释文本,并且它的Model Properties字段中也有文本,那么两个名称都会出现在生成的文件中。
使用一个万博1manbetx添加注释的文档块
打开模型后,从视图菜单中,选择库浏览器.
拖动DocBlock从Model-Wide公用事业在Simuli万博1manbetxnk库中导入模型。
双击DocBlock然后在编辑器中输入你想要的注释。保存并关闭编辑器。
右键单击DocBlock并选择掩码>掩码参数.
在代码生成模板符号框,键入以下之一:
摘要
描述
历史
ModifiedHistory
笔记
点击好吧.模板符号名区分大小写。
如果你正在使用DocBlock要向代码添加注释,请设置文档类型来
文本
.如果你设置文档类型来RTF
或超文本标记语言
,您的注释将不会出现在代码中。在“块属性”对话框中,在块注释选项卡上,选择
% < ECoderFlag >
并点击好吧.在上一步中键入的符号名称现在显示在DocBlock在模型中。保存模型。生成代码后,代码生成器将注释放在每个生成的文件中,其模板具有您键入的符号名。代码生成器将生成文件中的注释放在与符号名在模板文件中的位置相对应的位置。
要向生成的文件添加更多注释,请重复步骤1-7。
使用一个万博1manbetx注释添加注释
双击您想要放置注释的模型上的未占用区域。看到使用注释描述模型(万博1manbetx模型)。
类型
< S: Symbol_name >
后面跟着注释。Symbol_name
是下列之一:摘要
描述
历史
ModifiedHistory
笔记
例如,键入
这就是我想要的描述
.模板符号名区分大小写。(“S”
冒号前表示“符号”)如果你想让代码生成器对多个注释进行排序笔记
符号名称,将下一步替换为使用已排序的注释添加注释.单击矩形外部并保存模型。生成代码后,代码生成器将注释放在每个生成的文件中,其模板具有您键入的符号名。代码生成器将生成文件中的注释放在与符号名在模板文件中的位置相对应的位置。的多个注释进行排序
笔记
符号名称,将下一步替换为使用已排序的注释添加注释.要向生成的文件添加一个或多个其他注释,请重复步骤1-3。
使用一个Stateflow注意添加注释
右键单击statflow图中要放置注释的未占用区域。
从调色板中选择注释图标。
类型
< S: Symbol_name >
后面跟着注释。Symbol_name
是下列之一:摘要
描述
历史
ModifiedHistory
笔记
例如,键入
这就是我想要的描述
.模板符号名区分大小写。的多个注释进行排序笔记
符号名称,将下一步替换为使用已排序的注释添加注释.单击注释之外并保存模型。生成代码后,代码生成器将注释放在每个生成的文件中,其模板具有您键入的符号名。代码生成器将生成文件中的注释放在与符号名在模板文件中的位置相对应的位置。
要向生成的文件添加一个或多个其他注释,请重复步骤1-4。
使用已排序的注释添加注释
排序注释功能允许您向生成的文件添加自动排序的注释。代码生成器将这些注释放在每个生成的文件中对应于笔记
符号位于模板文件中。
代码生成器使用以下排序顺序:
字母前面有数字。
在数字中,0是第一位的。
在字母中,大写字母在小写字母之前。
可以将排序的注释与Simulink注释或statflow注释一起万博1manbetx使用,但不能与DocBlock.
在Simuli万博1manbetxnk注释或statflow注释中,键入
< S: NoteY >
接着是第一条评论。Y
是数字或字母。重复这一步骤,可以添加任意数量的注释。取代
Y
后面有一个数字或字母。
该图说明了模型上排序的注释,以及代码生成器将每个注释放在生成文件中的位置。
该模型生成文件的相关片段如下:
** NOTES ** Note1:这是我想与NOTES符号关联的第一个注释。注释2:这是我在Notes下面想要的第二个注释。注b:这是第三条评论。**