Personal tools
You are here: Home Community Help Center Reference Manuals RiskAnalytics Developer's Guide Components Conventions Naming convention

1.1.1. Naming convention

Up one level
Beside clean code and higher readableness naming convention, increase coding speed in modern IDE (integrated development environment) as code completion is supported.

A component may have several properties. There exist four prefixes to be used:

  • parm: whenever a variable name starts with parm. It is displayed on the parameterization user interface automatically.
  • in: all in variables of type PacketList receive packets from other components
  • out: all out variables of type PacketList send packets to other components. It is displayed on the result template user interface and optionally on the result page automatically.
  • sub: a component may have sub components. Their name has to start with sub.

Remark: If a component is written in Java, variables starting with any of these prefixes need a public setter and getter method.

Document Actions