主要内容

生成带有注释或注释的代码

以下章节描述了如何使用HDL Coder™软件向生成的代码添加文本注释，以模型注释、文本注释或需求注释的形式。

动态仿真模块注释

您可以像Simulink一样直接在框图上输入文本®注释。HDL Coder在生成的代码中将Simulink注释中的文本渲染为纯文本注释。注释是在模型层次结构中与包含注释的子系统相同的级别上生成的，就像它们是Simulink块一样。

为常数块，以将注释反映为HDL代码中的注释，清除减少中间信号复选框并设置可追溯性风格来评论的基础．

看到使用注释和注释描述模型有关注释的一般信息。

信号的描述

您可以为Simulink模型中的信号提供描述。生成的HDL代码将这些描述显示为信号声明语句上方的注释。要为信号指定描述，请右键单击信号并选择属性打开“信号属性”对话框。然后,选择文档选项卡，并在描述部分，输入对信号的描述。对于信号描述，使用ASCII字符，因为生成的代码中的非ASCII字符可能会潜在地干扰下游合成和lint工具。在某些情况下，由于对信号进行了某些优化，生成的代码可能不会将所有信号描述翻译为HDL注释，或者可能为某些信号描述创建HDL注释的副本。

文字评论

您可以在模型的任何级别上输入文本注释，方法是将DocBlock放置在所需的级别并输入文本注释。HDL Coder在生成的代码中将DocBlock中的文本呈现为纯文本注释。注释是在模型层次结构中与包含DocBlock的子系统相同的级别上生成的。

设置文档类型参数文本．HDL Coder不支持超文本标记语言或RTF选项。

看到DocBlock获取DocBlock的一般信息。

要求注释和超链接

您可以将需求注释分配到块中。

如果您的模型包含需求注释，您可以选择以以下格式之一呈现注释:

  • 生成代码中的文本注释:要将需求作为文本注释包含在代码中，请使用的默认值在块注释中包含需求()和生成可跟踪性报告(off)。

    如果从命令行生成代码，请设置可追溯性而且RequirementComments属性。该代码显示了为类生成的文本需求注释获得块的mcombo模型:

    open_system (“mcombo”) makehdl (gcb“可追溯性”，“关闭”，“RequirementComments”，“上”）;
    BEGIN In1_signed <= signed(In1);-- --块要求/增益—1。增益要求第1 - 2节。增益要求第二节Gain_gainparam <= to_signed(16384,16);Gain_out1 <= resize(In1_signed(15 DOWNTO 0) & '0' Out1 <= std_logic_vector(Gain_out1);rtl结束;

  • 超链接的评论:要将需求注释作为超链接注释包含在HTML代码生成报告中，请同时选择两者生成可跟踪性报告而且在块注释中包含需求在“配置参数”对话框中。

    如果从命令行生成代码，请设置可追溯性而且RequirementComments属性:

    makehdl (gcb),“可追溯性”，“上”，“RequirementComments”，“上”）;

    注释包括指向与块相关的需求文档的链接，以及指向原始模型中的块的链接。例如，下图显示了分配给一个Gain块的两个需求链接。链接指向文本需求文件的各个部分。

下面的代码显示了为Gain块生成的超链接需求注释。

BEGIN In1_signed <= signed(In1);--< S10 > /收益-- -- --块要求< S10 > /收益--1.增益要求第一节--2.增益要求第二节Gain_gainparam <= to_signed(16384,16);Gain_out1 <= resize(In1_signed(15 DOWNTO 0) & '0' Out1 <= std_logic_vector(Gain_out1);rtl结束;
Baidu
map