Main Content

Check folder names

Check ID: mathworks.jmaab_v6.ar_0002

Guideline: ar_0002: Usable characters for folder names

Description

Checks if folder names adhere to the following guideline standards.

  • Do not begin with a number.

  • Do not begin or end with an underscore.

  • Do not contain consecutive underscores.

  • Do not coincide with reserved MATLAB® words.

  • Contain only alphanumeric characters and underscores.

Note

Reserved MATLAB words include the following:

This check requires a Simulink® Check™ license.

Check Parameterization

This check contains sub-checks that correspond to sub IDs specified in the MAB and JMAAB modeling guidelines. You can use the Model Advisor Configuration Editor to specify which sub IDs (one or multiple) to execute.

For reference, the MAB guideline sub ID(s) that are recommended for use by the NA-MAAB and JMAAB modeling standards organizations are:

  • NA-MAAB — a, b, c, d, e, f

  • JMAAB — a, b, c, d, e, f

This check contains the following input parameters:

  • Allow MATLAB namespace allows you to include the folder names with the special characters, + or @.

  • Check hidden folders allows you to run the checks on the hidden folders in the model.

  • Additional folders to check allows you to include additional folders for running checks.

  • Exclude folders allows you to exclude folders from checking.

Results and Recommended Actions

Guideline Sub IDConditionRecommended Action
ar_0002_a: Characters allowed for folder namesOne or more folders have invalid names.Use only alphanumeric characters and underscores in folder names.
ar_0002_b: Number at the beginningOne or more folder names begin with a number.Use alphabetic characters at the beginning of folder names.
ar_0002_c: Underscore at the beginningOne or more folder names begin with an underscore.Use alphabetic characters at the beginning of folder names.
ar_0002_d: Underscore at the endOne or more folder names end with an underscore.Do not end folder names with underscores.
ar_0002_e: Consecutive underscoresOne or more folder names have consecutive underscores.Do not use consecutive underscores in folder names.
ar_0002_f: Single reserved MATLAB word The folder name is a reserved MATLAB word.Do not use reserved MATLAB words as folder names.

Capabilities and Limitations

  • Runs on library models.

  • Runs on nested sub directories.