Modelica.UsersGuide.Conventions.ModelicaCode

In this section the naming conventions of class and instance names, parameters and variables are specified. Additionally some format UsersGuide are stated.

Extends from Modelica.Icons.Information (Icon for general information packages).

Package Content

Name	Description
Format	Format
Naming	Naming convention

Modelica.UsersGuide.Conventions.ModelicaCode.Format

1. In the icon of a component the instance name is displayed (text string %name) in blue color. Parameter values, e.g., resistance, mass, gear ratio, are displayed in the icon in black color in a smaller font size as the instance name.
2. Comments and annotations should start with a capital letter, for example:
   parameter Real a = 1 "Arbitrary factor";.
   For Boolean parameters, the description string should start with "= true: ..", for example:
   parameter Boolean useHeatPort = false "= true, if heatPort is enabled";.

Extends from Modelica.Icons.Information (Icon for general information packages).

Modelica.UsersGuide.Conventions.ModelicaCode.Naming

1. Class and instance names are usually written in upper and lower case letters, e.g., "ElectricCurrent". An underscore may be used in names. However, it has to be taken into account that the last underscore in a name might indicate that the following characters are rendered as a subscript. Example: "pin_a" may be rendered as "pin_a".
2. Class names start always with an upper case letter, with the exception of functions, that start with a lower case letter.
3. Instance names, i.e., names of component instances and of variables (with the exception of constants), start usually with a lower case letter with only a few exceptions if this is common sense (such as T for a temperature variable).
4. Constant names, i.e., names of variables declared with the "constant" prefix, follow the usual naming conventions (= upper and lower case letters) and start usually with an upper case letter, e.g., UniformGravity, SteadyState.
5. The two connectors of a domain that have identical declarations and different icons are usually distinguished by _a, _b or _p, _n, e.g., Flange_a, Flange_b, HeatPort_a, HeatPort_b.
6. A connector class has the instance name definition in the diagram layer and not in the icon layer.

Variable names

In the following table typical variable names are listed. This list should be completed.

Extends from Modelica.Icons.Information (Icon for general information packages).