German English

Naming conventions

(0 votes)

For most of the names within a project OTX, the following naming conventions:

  • 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 dot. Each section begins with a letter and is the name of the folder in the file system.
      • Correct:
        • "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_] *"
    • Begins with a letter which optionally one or more are preceded by "_". Follow this alphanumeric characters including "_".
      • Correct:
        • "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_ *] "
    • Internal references for the naming convention corresponds to the OtxName
    • If the referenced element is outside the current document, is a prefix followed by a colon prefixed. The prefix also corresponds to the OtxName (OtxName: OtxName)
      • Correct:
        • "MyProcedure"
        • "X"
        • "Sig: mySignature5"
        • "Constants: PI"
  • Keywords

    To ensure the operational capability of OTX also should not keywords of programming languages. This is case sensitive. Below is a listing 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
    • fal­se
    • 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
    • shortlist
    • sizeof
    • stackalloc
    • static
    • string
    • struct
    • switch
    • this
    • throw
    • true
    • try
    • typeof
    • uint
    • ulong
    • unchecked
    • unsafe
    • ushort
    • using
    • VirtualCenter
    • void
    • volatile
    • while

See also

Other Resources

  • Created
    18th October 2011
  • Version
    9
  • Amended
    18th October 2011
  • Hits
    1211