Commands › CLIST Commands › CLIST Documentation Commands

CLIST Documentation Commands

CLIST documentation commands are identified by symbols rather than by keywords. The documentation commands are:

• COMMENT identified by "*" in column 1 of the CLIST command
• DEFINE identified by ":%n" in column 1 of the CLIST command

COMMENT Command

A COMMENT is a non-executable CLIST command which you may use for any documentational purpose within the body of a CLIST. The only COMMENT of any significance to the CLIST processor is the first command of a CLIST. If this command is a COMMENT, it will appear on the CLIST Maintenance screen as part of the informational display.

DEFINE Command

The DEFINE command is used to document the use of variable symbols within a CLIST. You may use one DEFINE command (:%n) for each CLIST variable (%n) appearing in the CLIST. The DEFINE command is not executable, but does have special significance to the CLIST processor. If you fail to supply a value (or NULL indicator) for a CLIST variable when you EXEC the CLIST, the CLIST processor will recognize that fact when it encounters a command using that CLIST variable (%n). The CLIST processor will construct the CLIST Command Prompt screen using the DEFINE command(s) for the missing variable(s) in the current command. You may then supply a value for the CLIST variable(s) which will be used until CLIST execution terminates.