Documenting Scripts

Particularly for complex scripts, it is very important that you document them internally.  Comment statements provide an effective way to do this.

Comments can be inserted throughout scripts to document the statements and logic.

Comments can be inserted by selecting “COMMENT statement” from the Script element’s Insert menu (or pressing Ctrl+M when in the Script dialog). The comment is inserted below the statement that was selected when this is done.  The following dialog will be displayed:

Comments can be up to 100 characters long.  They appear in the script as green text, prefaced by a double forward slash:

It should also be pointed out that the Description entered when a local variable is created in a script also serves as an excellent documentation tool.  These descriptions are shown in tool-tips when you hover over a Variable Definition or Variable Assignment statement:

Related Topics…