Click above to get retro games delivered to your door ever month!

Variable naming convention


 Rescue5 uses a modified version of Hungarian Notation, the
 international standard used by many programmers.

 Each variable name has a one character lower-case type prefix,
 for example:

   a    Array
   b    Code block
   c    Character
   d    Date
   l    Logical
   n    Number
   o    Object
   u    Nil
   x    Results of evaluating a macro
   v    Variable (changes type)
   _    Undefined

 Rescue5 allows you to define additional types in the
 VARIABLE.UDT file or modify the existing ones.

 Local variables that are declared in code-blocks and all static
 variables have a lower-case scope identifier following the
 type-prefix:

   b    Block local (code block parameter)
   s    Static

 Scope is not part of the Hungarian notation commonly used by
 programmers, Rescue5 includes a scope identifier to allow
 variables defined as having the same base name to be better
 differentiated.

 Following the scope identifier (or type-prefix if no scope
 identifier is required) is a short qualifier, with the initial
 letter in upper case and the rest in mixed case.

 Following the qualifier is an optional scope based ordinal
 number (used only if there is more than one variable with the
 same base name and scope).

 For example, nRow2 is the third numerical local variable within
 the current scope, containing information relating to a screen
 row.

 The Hungarian notation outlined above takes effect on the
 optional second pass.  Variable names after the first pass
 follow the simpler convention of scope and ordinal:

     Ln     Local variable n
     BLn    Local variable n declared in a code-block
     Si_n   Static variable n (i is an ordinal number)
     Pn     Local parameter n (declared in the parentheses
            following  a procedure name, parameters declared
            with the PARAMETER key word are private variables
            whose names are fully recovered)

 All other symbols are recovered with the names they were
 assigned in the original code, with the limitation that
 CA-Clipper will have truncated long names to 10 characters.

 Rescue5 will recover local, block local  and static variable
 names from code that was originally compiled with the
 CA-Clipper /b switch.