Skip to main content

Best practices on Naming Elements and Variables

Assigning identities

Ossi Galkin avatar
Written by Ossi Galkin
Updated over a year ago

Naming Elements

The best practice for Element naming relies on descriptive and understandable names that are not too long to keep the Process or Subprocess readable. Also, when naming Elements, a good rule of thumb is to limit the name length so that for instance a Task name does not exceed and overflow the Element itself. If the Process or Subprocess requires a more comprehensive and longer name for an Element, developers should utilize the documentation tools for better documentation.

Only Elements that are relevant to the logic and functionality of the Process or Subprocess should be named. This is done to avoid cluttering the Process with information that is not necessary. For instance, the naming of Return Elements may not give any additional information that would be useful, so therefore naming is not necessary or preferred.

Like with any other naming convention, naming Elements should be consistent and descriptive to provide the best readability of a Process or a Subprocess.

Naming Variables

There are three kinds of Variables to be named in Frends: Process Variables, Environment Variables, and Variables in custom code, and they should follow the same naming convention. As Frends utilizes C# in code statements and handlebars, it is suggested to implement the same naming convention in the Variables as C#.

In all cases when naming Variables in Frends, they should be short, descriptive and stylized with camel case.

For more information, refer to Microsoft C# code naming conventions.

Did this answer your question?