MAB建模规范-Naming Conventions命名规范

规则ID:db、jm、hd、ar被用于Ver 1.0的规范。na和jc用于从版本2.0到现在创建的规范
NA-MAAB代表北美和欧洲。J-MAAB代表日本

目录

Naming Conventions命名规范

General Conventions基础规则

ar_0001: 文件名命名规范

ar_0002:文件夹命名规范

jc_0241:模型文件名长度限制

jc_0242:文件夹名长度限制

Content Conventions建模规则

jc_0201:子系统名命名规范

jc_0231:block命名规范

jc_0211:输入输出block命名规范

jc_0243: 子系统名长度限制

jc_0247:block名长度限制

jc_0244:输入输出block长度限制

jc_0222:信号名命名规范

jc_0232:参数名命名规范

jc_0245:信号名长度限制

jc_0246:参数名长度限制

jc_0795:stateflow数据名命名规范

jc_0796: stateflow数据名长度限制

jc_0791:重复数据名定义

jc_0792:未使用的数据

jc_0700:statflow块中未使用的数据

na_0019:变量名限制


Naming Conventions命名规范

General Conventions基础规则

ar_0001: 文件名命名规范

规则建议:

NA-MAAB: a, b, c, d, e, f ,g

JMAAB: a, b, c, d, e, f ,g

Matlab版本:all

规则:

a:在文件名中只有这些字符类型应使用:单字节字母数字字符(a-z, A-Z, 0-9),单字节下划线(_),不能使用换行符、单字节空格、双字节字符(如中文)和控制字符(如-,括号)

错误示例:

MAB Model.slx -含空格

模型.slx MAB-Model.slx -含中文,-字符

b: 文件名不能以数字开头

错误示例:001_JMAABModel.slx

c:文件名不能以下划线开头

错误示例:_JMAABModel.slx

d:文件名不能以下划线结尾

错误示例:JMAABModel_.slx

e:文件名不能使用连续的下划线

错误示例:JMAAB__Model.slx

f:文件名不能使用matlab预设的字符

错误示例:ans.slx double.slx week.slx zero.slx等

g:matlab不同路径下的文件名不得相同

错误示例:同名文件被保存到不同MATLAB路径的文件夹中

原因:

abcf:可读性差,不按规则可能会发生意外的结果

de:可读性差

g:如果有多个同名文件,则加载该路径上较高的那个文件。因此,可能会包含不必要的文件。可读性差,不按规则可能会发生意外的结果

ar_0002:文件夹命名规范

a-f同上,只是改为文件夹名

jc_0241:模型文件名长度限制

规则建议:

NA-MAAB: a

JMAAB: a

Matlab版本:all

规则

a:模型文件名长度不超过63个字符(不包括点和扩展名)。

原因

a:长度超过可能无法被引用

jc_0242:文件夹名长度限制

同上模型文件名长度

文件夹名长度超过可能导致在用户界面中无法显示完整路径名。

Content Conventions建模规则

jc_0201:子系统名命名规范

规则建议:

NA-MAAB: a, b, c, d, e, f

JMAAB: a, b, c, d, e, f

Matlab版本:all

规则:

同ar_0001中的 a, b, c, d, e, f

原因:

abf:无法使用配置的结构子系统名称生成代码。

cde:可能无法使用配置的结构子系统名称生成代码。

jc_0231:block命名规范

规则建议:

NA-MAAB: a, b, c, d, e, f

JMAAB: a, b, c, d, e, f

Matlab版本:all

规则:

同ar_0001中的 a, b, c, d, e, f 。

在添加新的块名时,不允许使用换行符和单字节空格。然而,当它们最初作为存储在Simulink库中的块名使用时,应该是允许的。

原因:

ab:偏离规则会使维护模型和代码的完整性变得困难

ce:可读性差

d:下划线可以用来分隔单词。然而,它们通常用作断句,可能会在描述中引起误解。可读性差

f:可读性差,偏离规则可能会导致意想不到的问题

jc_0211:输入输出block命名规范

规则建议:

NA-MAAB: a, b, c, d, e, f

JMAAB: a, b, c, d, e, f

Matlab版本:all

规则:

同ar_0001中的 a, b, c, d, e, f 。

原因:

ab:偏离规则会使维护模型和代码的完整性变得困难

ce:可读性差

d:下划线可以用来分隔单词。然而,它们通常用作断句,可能会在描述中引起误解。可读性差

f:可读性差,偏离规则可能会导致意想不到的问题

jc_0243: 子系统名长度限制

规则建议:

NA-MAAB: a

JMAAB: a

Matlab版本:all

规则

a:子系统名长度不超过63个字符

原因

a:长度超过可能无法生成代码

jc_0247:block名长度限制

规则建议:

NA-MAAB: a

JMAAB: a

Matlab版本:all

规则

a:block名长度不超过63个字符

原因

a:长度超过可能无法生成代码

jc_0244:输入输出block长度限制

规则建议:

NA-MAAB: a

JMAAB: a

Matlab版本:all

规则

a:输入输出block名长度不超过63个字符

原因

a:长度超过可能无法生成代码

jc_0222:信号名命名规范

规则建议:

NA-MAAB: a, b, c, d, e, f

JMAAB: a, b, c, d, e, f

Matlab版本:all

规则:

同ar_0001中的 a, b, c, d, e, f 。

原因:

ab:偏离规则会使维护模型和代码的完整性变得困难

ce:可读性差

d:下划线可以用来分隔单词。然而,它们通常用作断句,可能会在描述中引起误解。可读性差

f:可读性差,偏离规则可能会导致意想不到的问题

jc_0232:参数名命名规范

规则建议:

NA-MAAB: d, e

JMAAB: a, b, c, d, e, f

Matlab版本:all

规则:

e, f 。

原因:

ab:偏离规则会使维护模型和代码的完整性变得困难

ce:可读性差

d:下划线可以用来分隔单词。然而,它们通常用作断句,可能会在描述中引起误解。可读性差

f:可读性差,偏离规则可能会导致意想不到的问题

jc_0245:信号名长度限制

规则建议:

NA-MAAB: a

JMAAB: a

Matlab版本:all

规则

a:输入输出block名长度不超过63个字符

原因

a:长度超过可能无法生成代码

jc_0246:参数名长度限制

规则建议:

NA-MAAB: a

JMAAB: a

Matlab版本:all

规则

a:输入输出block名长度不超过63个字符

原因

a:长度超过可能无法生成代码

jc_0795:stateflow数据名命名规范

规则建议:

NA-MAAB: a,b,c,d

JMAAB: a,b,c,d

Matlab版本:all

规则

同ar_0001中的 a, b, c, d

原因

abcd:可读性差,不按规则可能会发生意外的结果

jc_0796: stateflow数据名长度限制

规则建议:

NA-MAAB: a

JMAAB: a

Matlab版本:all

规则

a:stateflow数据名长度不超过63个字符

原因

a:长度超过可能无法生成代码

jc_0791:重复数据名定义

规则建议:

NA-MAAB: a,b,c

JMAAB: a,b,c

Matlab版本:all

规则

a: 基本工作区和模型工作区数据定义不能重复

b: 基本工作区和数据字典数据定义不能重复

c: 模型工作区和数据字典数据定义不能重复

原因

abc:重复的数据名称可能会导致意外的模型行为

jc_0792:未使用的数据

规则建议:

NA-MAAB: a,b

JMAAB: a,b

Matlab版本:all

规则

a: 数据字典只定义 simulink 或 stateflow 里使用到的数据;

b: 模型工作区只定义 simulink 或 stateflow 里使用到的数据;

原因

ab:未使用的数据可能会影响可维护性和可操作性。

jc_0700:statflow块中未使用的数据

规则建议:

NA-MAAB: a,

JMAAB: a

Matlab版本:all

规则

a: 未使用的数据、事件、消息会导致错误提示与报警

原因

a:statflow块中未使用的数据和事件会影响可维护性和可重用性。将未使用的数据插入到生成的代码中,作为声明性语句影响代码。

na_0019:变量名限制

规则建议:

NA-MAAB: a,b

JMAAB: 不支持

Matlab版本:all

规则

a:matlab代码里不使用预留的 C 变量名 例如:const, TRUE, FALSE, infinity, nil, double, single, enum 等

b:不使用与 matlab 函数冲突的变量名 例如:conv 等

原因

ab:提高代码可读性,可能无法生成代码

  • 3
    点赞
  • 9
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 3
    评论
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

赞哥哥s

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值