> For the complete documentation index, see [llms.txt](https://ctrl.gitbook.io/innovant/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ctrl.gitbook.io/innovant/master.md).

# Variables

Variable Naming Conventions and Best Practice Guidelines

## Types:

Dimensional Unit Types should be used in conjunction/proceeding the declared underlying asset.

The flowing is a table of common Types:

| Variable Types | Declaration |
| -------------- | ----------- |
| Height         | H           |
| Width          | W           |
| Depth          | D           |
| Length         | L           |
| Thickness      | Thk         |
| Diameter       | Dia         |
| Angle          | Ang         |

## Conventions & Guidelines:

### Structural Formatting

* Declare your underlying asset prior to declaring a type. 

Example:

```
Cabinet_W = 30
```

{% hint style="info" %}
In the above example, the Cabinet is the underlying asset which is followed by it's type "W" 
{% endhint %}

* Words shorter than 4 characters should not be abbreviated.

### Casing and Styles

* The first word of all declared variables should be spelled out in full (no abbreviations).<br>
* Variables should be written using a combination of ***under\_score*** and ***Camel Case*** casing styles with each word separated by an underscore and each first letter capitalized.\
  \
  Use of an underscore eliminates confusion when dealing with multiple characters of the same value. \
  \
  Example: Compare the following variables

```
(PhilL/2) * SomeVar

(Phil_L/2) * Some_Var
```

* Constants should be declared using CAPITAL LETTERS to denote it should be treated as a constant. \
  \
  Example:&#x20;

```
INCH_MILLIMETER_RATIO = 25.4
```

{% hint style="info" %}
We know that the conversion ratio for 1” to millimetres is a constant equal to 25.4, therefore there is no reason to change the value of this variable.&#x20;
{% endhint %}