General.NamingConventions

Introductions

Following naming conventions apply to most of the names within a OTX project:

• Root node
  • No naming conventions

• Package
  • The naming convention follows the following regular expression: "(. \ [a-zA-Z] [a-zA-Z0-9] *) [a-zA-Z] [a-zA-Z0-9] * *"
  • Divided into one or more parts of alphanumeric characters separated by a period. Each part begins with a letter and corresponds to the name of the folder in the file system.
    • Right:
      • "Com.MyCompany.OtxSequences5"
      • "My5OtxSequences"
    • Wrong:
      • "Com._MyCompany.OTX"
      • "MesSéquencesTest"
      • "9thPackage"
      • ""

• OtxName
  • The naming convention follows the following regular expression: "_ * [a-zA-Z] [a-zA-Z0-9_] *"
  • Starts which are optionally one or more "_" prefixed with a letter. This is followed by alphanumeric characters including "_".
    • Right:
      • "MyProcedure"
      • "__validity10"
      • "PI"
      • "_y2"
    • Wrong:
      • "9x"
      • "___"
      • ""

• OtxLink
  • The naming convention follows the following regular expression: "(_ * [a-zA-Z] [a-zA-Z0-9_] * :) _ * [a-zA-Z] [a-zA-Z0-9_]? *"
  • For internal references the naming convention corresponds to the OtxName
  • If the referenced element is outside of the current document, a prefix followed by a colon is prepended. The prefix also corresponds to the OtxName (OtxName: OtxName)
    • Right:
      • "MyProcedure"
      • "X"
      • "Sig: mySignature5"
      • "Constants: PI"

• Keywords

  To ensure the operational capability of OTX also no keywords of programming languages ​​should be used. The case will be respected in this regard. Below you will find a list of Keywords of C#:

  • abstract
  • as
  • base
  • bool
  • break
  • byte
  • case
  • catch
  • char
  • checked
  • class
  • const
  • continue
  • decimal
  • default
  • delegate
  • do
  • stand-in
  • else
  • enum
  • event
  • explicit
  • external
  • false
  • finally
  • fixed
  • float
  • for
  • foreach
  • goto
  • if
  • implicit
  • in
  • int
  • interface
  • internal
  • is
  • lock
  • long
  • namespace
  • new
  • zero
  • object
  • operator
  • out
  • override
  • params
  • private
  • protected
  • public
  • read only
  • ref
  • return
  • sbyte
  • sealed
  • short
  • sizeof
  • stackalloc
  • static
  • string
  • struct
  • switch
  • this
  • throw
  • true
  • try
  • typeof
  • uint
  • ulong
  • unchecked
  • unsafe
  • ushort
  • using
  • virtual
  • void
  • volatile
  • while

See also

Validation (OTX-Checker)
​​Imports
Declarations
Visibilities
Validities
Signatures
Parameter Declarations
Procedures
Comments