Main Content

配置代码注释

通过修改代码生成 > 注释窗格中的参数,配置代码生成器如何将注释插入到生成的代码中。

目的操作

在生成的代码中包括注释

包括注释。选择此参数允许您选择一个或多个自动生成的注释类型以放在代码中。

包括描述 Simulink 模块代码的注释

Simulink 模块注释。选择此参数会在生成的代码中包含注释,注释位于 Simulink® 模块的代码之前。在 Embedded Coder® 中,使用使用以下方式追溯至模型选择模块路径Simulink 标识符作为注释格式。

包括描述 Stateflow 对象的注释

Stateflow 对象注释。选择此参数会在生成的代码中包含描述 Stateflow® 对象的注释。在 Embedded Coder 中,使用使用以下方式追溯至模型选择模块路径Simulink 标识符作为注释格式。

包括 MATLAB 源代码作为注释

MATLAB 源代码作为注释。选择此参数会在关联的生成代码前插入这些注释。函数签名包含在函数前注中。

包含对已消除代码块的注释

显示已消除代码块。选择此参数将包括因优化而消除的代码块(如内联参数)的注释。

包括参数注释,而不考虑参数数目

为 '模型默认' 存储类提供详尽注释。选择此参数会包括 model_prm.h 中模型参数结构体声明中参数变量名称和源块名称的注释。

如果不选择此参数,则在声明的参数少于 1000 个时会生成参数注释。对于具有大量参数的模型,这将减小生成文件的大小。

包括 MATLAB 用户注释

MATLAB 用户注释。选择此参数会将 MATLAB® 代码中的函数描述注释和其他用户注释作为注释包含在生成代码中。

指定注释样式

注释样式。选择 AutoMulti-lineSingle-line 作为生成代码中的注释样式。

注意

当您配置代码生成器以生成包括注释的代码时,代码生成器会在生成代码注释中包含模型参数、模块名称、信号名称和 Stateflow 对象名称的文本。如果该文本包含模型的字符集编码中未表示的字符,代码生成器会用 XML 转义序列替换这些字符。例如,代码生成器用转义序列 ア 替换日语全角片假名字母 ア。有关详细信息,请参阅 国际化和代码生成

相关主题