Qorus’ Recommended Naming Conventions

Introduction

Every organization should come up with its own naming conventions; the naming conventions described here are recommendations that can be used as a starting point for new projects.

The format of names has no functional impact on the system; the naming convention should provide consistency and clarity of implementations and configurations across development releases and therefore helps to reduce long-term development and maintenance costs.

Qore Naming Conventions

• ModuleName
• function_name
• methodName
• variable_name
• classVariableName, staticClassVariableName
• CONSTANT_NAME

Camel case names should have the first letter of each word or acronym capitalized; ex:

• HtmlClass
• DbInterface

Note: for unused variable it is commonly used _ (e.g. int sub foo(int x, auto _) { return x + 1; }

See Qore Naming Conventions in the Qore Programming Language Wiki for more information.

Qorus Naming Conventions

Qorus Objects

• async-queue-name
• connection-name
• event-name
• fsm-name
• INTERFACE-GROUP-NAME
• job-name
• mapper-name
• pipepine-name
• service-name
• StepName
• WORKFLOW-NAME
• tests: should have the same name as the interface being tested without the version number in the test file name, unless there are multiple versions of the object in Qorus used at the same time (ex: workflows or in some classes classes or mappers)

Library Files

Library files should have the same name as the class defined. Only one library object should be defined in each file unless the library object is a part of the fundamental infrastructure for a project.