| Name: | *(COMMENT) | Shortest: | *(COMMENT) OR -- COMMENT |
|---|---|---|---|
| Family: | Command | Category: | Programming |
| Description: | Use comments in command or application files to provide internal program documentation. | ||
Although used primarily in command files, you can enter a comment at the R> prompt.
If you place a comment on the same line as a command, leave at least one space between the comment and the command so the comment is not interpreted as part of the command.
R:BASE interprets text following an asterisk and left parenthesis as a comment until a closing right parenthesis is reached. If the right parenthesis is not entered, R:BASE responds with a continuation prompt (+>). Enter a closing parentheses until you are returned to the R> prompt, or other processing.
A carriage return at the end of the line indicates the end of the text for a comment that begins with two hyphens. You can use a comment beginning with two hyphens following a command or on a line of its own.
The following example illustrates how internal parentheses can be included in a comment.
Do not include comments within the text of an ASCII menu file or a menu block because the comment will be read as part of the file.
A command that is embedded within a multiple-line comment will not be executed.
A comment beginning with two hyphens cannot extend to a second line.
The following command lines are all valid comments or contain valid comment formats.
*(This is a comment that occupies one line) *(This is a comment that occupies more than one line) SET VARIABLE varint1 = 1 -- Initialize the variable named varint -- This is a comment line SET VARIABLE varint1 = 1, varint2 = 1 *(Initialize two variables)