Simulink建模规范(MAAB)之命名转换规则

1、ar_001: Filenames

ID: Title

ar_0001: Filenames(文件名)

Priority

Mandatory(强制)

Scope

MAAB

MATLAB  Version

all

Prerequisites

 None

Description

一个文件名需符合以下约束条件:

1、构成:

文件名=名字.扩展名

名字:无数字开头,无空格

扩展名:无空格

2、独特性:

目录树中所有的文件名都必须独一无二

3、允许的字符:

名字:
a b c d e f g h i j k l m n o p q r s t u v w x y z 
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 
0 1 2 3 4 5 6 7 8 9 _

扩展名:

a b c d e f g h i j k l m n o p q r s t u v w x y z 

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 
0 1 2 3 4 5 6 7 8 9

4、下划线:

名字:

-可以使用下划线分割不同的组成

-不能有多个连续下划线

-不能以下划线开始

-不能以下划线结尾

扩展名:

-不能使用下划线

 

 

 

Rationale

☑Readability  ☐Verification and Validation

☑Workflow     ☑Code Generation

☑Simulation

Last  Change

V3.0

2、ar_002: Directory names

ID: Title

ar_002: Directory names(文件夹名称)

Priority

Mandatory(强制)

Scope

MAAB

MATLAB  Version

all

Prerequisites

 None

Description

一个文件夹名称需符合以下约束条件:

1、构成:

文件夹名称=名字

名字:无数字开头,无空格

2、独特性:

目录树中所有的文件夹名称都必须独一无二

3、允许的字符:

名字:
a b c d e f g h i j k l m n o p q r s t u v w x y z 
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 
0 1 2 3 4 5 6 7 8 9 _

 

4、下划线:

名字:

-可以使用下划线分割不同的组成

-不能有多个连续下划线

-不能以下划线开始

-不能以下划线结尾

扩展名:

-不能使用下划线

 

 

 

Rationale

☑Readability  ☐Verification and Validation

☑Workflow     ☑Code Generation

☑Simulation

Last  Change

V1.0

3、na_0035: Adoption of naming conventions

ID: Title

na_0035: Adoption of naming conventions(采用命名规范)

Priority

Recommended(推荐)

Scope

NA-MAAB

MATLAB  Version

ALL

Prerequisites

 None

Description

推荐采用命名规范,命名规范对模块、信号、参数和数据类型命名提供了指导。命名规范通常涵盖以下:

1、符合编程语言和工具链

-长度

-可使用的字符

2、可读性

-命名中使用下划线

-命名中使用大写字母

3、编码信息

-使用具有关联意义的名字

-使用标准的缩写和缩略语

-数据类型命名

-工程单元命名

-所有权命名

-存储类型命名

Rationale

☑Readability  ☐Verification and Validation

☑Workflow     ☑Code Generation

☑Simulation

Last  Change

V3.0

4、jc_0201: Usable characters for Subsystem

ID: Title

jc_0201: Usable characters for Subsystem(子系统命名)

Priority

Strongly recommended(强制推荐)

Scope

MAAB

MATLAB  Version

ALL

Prerequisites

 None

Description

子系统命名须符合以下约束条件:

1.构成:

   名字:

-不能以数字开头

-不能包含空格

-不能包含回车

2、允许字符

name:
a b c d e f g h i j k l m n o p q r s t u v w x y z 
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 
0 1 2 3 4 5 6 7 8 9 _

 

3、下划线

名字:

-可以使用下划线分割不同的组成

-不能有多个连续下划线

-不能以下划线开始

-不能以下划线结尾

 

Rationale

☑Readability  ☐Verification and Validation

☐Workflow     ☐Code Generation

☐Simulation

Last  Change

V2.2

5、jc_0211: Usable characters for Inport blocks and Outport blocks

ID: Title

jc_0211: Usable characters for Inport blocks and Outport blocks(输入输出模块命名)

Priority

Strongly recommended(强制推荐)

Scope

MAAB

MATLAB  Version

ALL

Prerequisites

 None

Description

输入输出模块命名须符合以下约束条件:

1.构成:

   名字:

-不能以数字开头

-不能包含空格

-不能包含回车

2、允许字符

name:
a b c d e f g h i j k l m n o p q r s t u v w x y z 
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 
0 1 2 3 4 5 6 7 8 9 _

 

3、下划线

名字:

-可以使用下划线分割不同的组成

-不能有多个连续下划线

-不能以下划线开始

-不能以下划线结尾

 

Rationale

☑Readability  ☐Verification and Validation

☐Workflow     ☐Code Generation

☐Simulation

Last  Change

V2.2

6、jc_0221: Usable characters for signal line names

ID: Title

jc_0221: Usable characters for signal line names(线上名字命名)

Priority

Strongly recommended(强制推荐)

Scope

MAAB

MATLAB  Version

ALL

Prerequisites

 None

Description

线上名字命名须符合以下约束条件:

1.构成:

   名字:

-不能以数字开头

-不能包含空格

-不能包含回车

2、允许字符

name:
a b c d e f g h i j k l m n o p q r s t u v w x y z 
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 
0 1 2 3 4 5 6 7 8 9 _

 

3、下划线

名字:

-可以使用下划线分割不同的组成

-不能有多个连续下划线

-不能以下划线开始

-不能以下划线结尾

 

Rationale

☑Readability  ☐Verification and Validation

☐Workflow     ☐Code Generation

☐Simulation

Last  Change

V2.2

7、na_0030: Usable characters for Simulink® Bus names

ID: Title

na_0030: Usable characters for Simulink® Bus names(总线命名)

Priority

Strongly recommended(强制推荐)

Scope

NA-MAAB

MATLAB  Version

ALL

Prerequisites

 None

Description

总线命名须符合以下约束条件:

1.构成:

   名字:

-不能以数字开头

-不能包含空格

-不能包含回车

2、允许字符

name:
a b c d e f g h i j k l m n o p q r s t u v w x y z 
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 
0 1 2 3 4 5 6 7 8 9 _

 

3、下划线

名字:

-可以使用下划线分割不同的组成

-不能有多个连续下划线

-不能以下划线开始

-不能以下划线结尾

 

Rationale

☑Readability  ☐Verification and Validation

☐Workflow     ☐Code Generation

☐Simulation

Last  Change

V2.2

8、jc_0231: Usable characters for block names

ID: Title

jc_0231: Usable characters for block names(模块命名)

Priority

Strongly recommended(强制推荐)

Scope

MAAB

MATLAB  Version

ALL

Prerequisites

 jc_0201: Usable characters for Subsystem names

Description

模块命名须符合以下约束条件:

1.构成:

   名字:

-不能以数字开头

-不能包含空格

-不能包含回车

2、允许字符

name:
a b c d e f g h i j k l m n o p q r s t u v w x y z 
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 
0 1 2 3 4 5 6 7 8 9 _

 

3、下划线

名字:

-可以使用下划线分割不同的组成

-不能有多个连续下划线

-不能以下划线开始

-不能以下划线结尾

 

Rationale

☑Readability  ☐Verification and Validation

☐Workflow     ☐Code Generation

☐Simulation

Last  Change

V2.0

9、na_0014: Use of local language in Simulink and Stateflow

ID: Title

na_0014: Use of local language in Simulink and Stateflow(Simulink 和Stateflow语言注释)

Priority

Strongly recommended(强制推荐)

Scope

J-MAAB

MATLAB  Version

ALL

Prerequisites

None

Description

语言注释只能在描述区域使用。描述区域是指不影响代码生成或者仿真的区域。

1.在Simulink 或Stateflow描述属性对话框中;

2.在Simulink 或Stateflow图形界面中做辅助注释。

Rationale

☑Readability  ☐Verification and Validation

☐Workflow     ☐Code Generation

☐Simulation

Last  Change

V2.0

更多精彩干货分享,请关注我的个人微信公众号:MBD开发者星球;

你可能感兴趣的:(MATLAB)