在生成的代码中添加全球评论
这些例子展示了如何添加一个全球评论仿真软件金宝app®模型的评论文本出现在生成的文件或文件。指定一个模板模型的符号名金宝appDocBlock、动态仿金宝app真模块注释或Stateflow®请注意。您还可以使用一个sorted-notes能力,使用仿真软件注释或Stateflow笔记,但不是金宝appDocBlock年代。关于模板的更多信息符号,明白了模板的符号和规则。
请注意
模板的名字象征描述
和模型信息
字段在属性检查器对话框。如果你使用其中一个全球评论文本及其符号名称属性检查器领域也有文本,这两个名字出现在生成的文件。
使用一个金宝appDocBlock添加评论
打开一个仿真软金宝app件模型。
模型=“rtwdemo_codetemplate”;open_system(模型)
根据配置参数,设置代码模板来
rtwdemocodetemplate.cgt
。这段代码模板包含所需的定制生成全球评论。右键单击DocBlock并选择面具>面具参数。
在代码生成模板的象征框中,输入以下命令之一:
文摘
描述
历史
笔记
点击好吧。模板名称是区分大小写的象征。
如果您使用的是DocBlock将评论添加到您的代码,设置文档类型来
文本
。如果你设置文档类型来RTF
或HTML
,你的评论不出现在代码。在属性对话框,块注释选项卡上,选择
% < ECoderFlag >
并点击好吧。您输入的符号名的前一步现在似乎下DocBlock在模型中。保存模型。在您生成代码,代码生成器的评论在每个生成的文件模板指定的符号名称。代码生成器的地方注释生成的文件的位置,对应的符号名称位于模板文件。
这个模型的相关片段生成的文件是:
* *文摘:*此文本映射到代码模板% <文摘>符号。
添加更多的评论所生成的文件,重复步骤2 - 6。
使用一个金宝app注释添加评论
打开模型
rtwdemo_codetemplate
。双击空置面积的模型,你想评论的地方。看到标注模型。
类型
< S: Symbol_name >
其次是评论。Symbol_name
是下列之一:文摘
描述
历史
笔记
例如,类型
< S:描述>这是我想要的描述
。模板名称是区分大小写的象征。如果你想要排序多个注释的代码生成器笔记
符号名称,替换下一个步骤使用排序的笔记添加评论。单击注释矩形外并保存模型。在您生成代码,代码生成器的评论在每个生成的文件模板你指定的符号名。代码生成器的地方注释生成的文件的位置,对应的符号名称位于模板文件。如果你想要排序多个注释的代码生成器
笔记
符号名称,替换下一个步骤使用排序的笔记添加评论。添加一个或多个其他注释生成的文件,重复步骤2 - 4。
使用排序的笔记添加评论
sorted-notes功能使您能够分类注释添加到生成的文件。代码生成器的地方这些评论在每个生成的文件的位置相对应笔记
符号是位于模板文件。
代码生成器使用这个排序顺序:
数字字母之前。
在数字,0是第一。
在字母,大写字母小写字母前放置。
您可以使用排序模型注释或Stateflow报告指出,但不是金宝appDocBlock。
动态仿真模块注金宝app释或Stateflow注意,类型
< S: NoteY >
其次是第一个发表评论。Y
是一个数字或一个字母。重复这个过程尽可能多的你想要额外的评论。取代
Y
后续的数字或字母。
这幅图描绘了笔记分类模型。它显示了代码生成器生成的文件中的每一个注意的地方。
这个模型的相关片段生成的文件是:
* *注:*注意:这个模型注释映射到代码模板% 金宝app<报告>的象征。*注一:另一个仿真软件注释。金宝app*
限制
你不能使用模板生成全球注释符号名称在仿真软件金宝appDocBlock,当语言对于代码生成c++
。