Naming Conventions

Veritran Docs

Naming Conventions

This section outlines best practices for naming processes, variables, functions, and their corresponding parameters, as well as the data provided within a process. Using clear names makes it easier to quickly identify the purpose of a process or element within the process, and facilitates the understanding of the underlying logic.

Process Name and Basic Information

The name, description, and tags of a process make up its main identity. Below, you will find best practices to apply when defining these elements:

Process Content

This section outlines best practices for naming Lambda variables, functions, and their parameters.

Lambda variables are used during the execution of the process. Unlike parameters, these variables can be used anywhere within the lambda process and are not limited to a specific function. When creating variables, consider the following best practices:

Use camelCase (e.g., userName).
Define the name based on the content, not just the type (e.g., userEmail).
Avoid ambiguous abbreviations.
Include data structure context (e.g., fixedTermId, fixedTermDesc).
Include units when applicable (e.g., fixedTermAmountDollars).

Functions allow you to encapsulate parts of a process logic, improving reusability, readability, and code organization. Each function can receive input parameters, process information, and return a value. Functions are local to the lambda process in which they are defined.

Functions share many principles with other structures like processes and variables. When creating functions, consider the following best practices:

Use infinitive verbs and camelCase (e.g., validateEmail, formatDate).
Name clearly—the function name should clearly state what it does.
Avoid excessively long functions.
Reuse instead of repeating code.
Use consistent naming across similar functions. If multiple functions perform related operations, use the same convention (e.g., validate, format, calculate, filter, find, update).

Parameters allow information to be passed to functions. Using parameters enables better encapsulation and decoupling of specific logic. The best practices outlined for variables also apply to parameters, as well as the following:

Use the letter "p" as a prefix to differentiate it from a variable.
Do not repeat the function name in the parameter.
Avoid unnecessary parameters.
When applicable, maintain consistency with input variables to improve traceability.
Use logical parameter order. When more than one parameter is used, order them according to the function’s natural flow.

In this section:

Was this helpful?

Would you like to provide feedback? Just click here to suggest edits.

Veritran Docs

Naming Conventions

Process Name and Basic Information

Process Content

Search results