C

Includes a comment.

Syntax

C
*

Operation

The C command lets you include a comment in a Proc that will be ignored when the Proc is executed. Comments help a great deal when modifying or debugging a Proc.

Many programmers use line 2 of a Proc as a comment line to briefly describe the use of the Proc and line 3 for the name of the programmer and date it was written. They then create synonym definition items in the Proc file dictionary so that when the Proc file is listed by the English processor, the comment lines will be displayed.

However, it is not wise to place too many comment lines at the beginning of the program since the Proc processor starts at the beginning of the Proc when searching for a statement label (unless the Proc has been compiled using the PQ-COMPILE command from TCL).

Comments

Comments may be added to some commands by following the command with a subvalue mark, then 'C' or '*', then the comment. However, some commands should not be followed by another command on the same line; these are listed in Multiple Commands.

Example

001 PQN
002 C This Proc will SORT or LIST a file
003 C Rob Nelson, Aug. 19, 1995
004 RI
005 RO
006 5 T C,(10,10),"Choose S to SORT a file or L to LIST
     a file (S/L)",S5,+
007 IP %1 \C Input S or L
.
.
.

In this example, lines 002 and 003 are comment lines. On line 007, the Proc processor executes the IP command and ignores the comment because it is separated from the IP command by a subvalue mark (entered as CTRL+\, displayed as \).