Coding Standards

The standards are for all testers using the IDE of Rational Robot to develop their automated test scripts.

The mission is to reduce maintenance costs when it comes to changes. This is done by setting up rules on how to name variables, functions, scripts and libraries, where to place them and when to use them.

The standards do not provide any information about the use of frameworks, best practices, Rational Robot settings and version control. These are all provided in separated documents.

Description

Variables represent values that can be changed within a procedure or function. Local scope variables are placeholders that reside within a function- or a script-body.

Syntax

[Prefix]+[ShortDescription]

[Prefix] is a lowercase letter (either "n", s", "str", "d" or "t" appropriate to the type it represents)

[ShortDescription] is a corresponding name of what the variable stands for.

If [ShortDescription] consists of more then one word they are all separated using a capital letter for each new word.

Description

Constants are “variables” that cannot be changed within a function- or script-body. The value will always be the same during script-execution.

Syntax

"AX_" + [PURPOSE] + {OPTIONAL}

If the constant name consists of more than one word those will be separated using an underscore.

Examples

· AX_AUT_VERSION

· AX_DEFAULT_URL

Description

Arrays in many programming-languages usually represent a fixed list of values (e.g. a list of lastnames). However within SQABasic the size for an array can either be fixed or grow if the number of items in the list is not known during compilation of the source code.

Syntax

"a" + [Prefix]+[ShortDescription]

Letter “a” indicates that the variable is of type array. [Prefix] is a lowercase letter that represents the type of variables in the array. The rules for [Prefix] are the same as for “Local scope variables”.

Examples

· asPersonList

· anNumberList