HP Integrity NonStop H-Series User Manual

Page 295

Advertising
background image

Adding Comments to a File

Using Special TFORM Features

058060 Tandem Computers Incorporated

11–27

Adding Comments

to a File

TFORM provides a way for you to document the contents in an edit file.
Perhaps you want to make notes on the data in the file, or to remind
yourself of the way you’ve set up the commands. You might want to
provide instructions to others who use the file. Anytime you want to
include information in a file, but you don’t want the information printed,
you use the COMMENT command.

There are two versions of the COMMENT command:

\COMMENT

\!

You can use either one of these versions when you’re putting the comment
on a line by itself. For example:

\COMMENT This figure will be provided by graphics.

\! Check the page number of this reference.

You don’t need to start a comment line at the far left of a line. You can
insert comments anywhere in the file. If you’re adding a comment to a line
that begins with another command, you must use the COMMENT version.
The exclamation point (!) version of the command can appear in either text
lines or command lines:

\STYLE MARGIN TOP 3; COMMENT This leaves room for

the logo

\! You must \SET JOIN ON for this to format

correctly.

\ ......as explained in Chapter 4. \! Check chapter

number

When you use the COMMENT version on a command line, you follow the
usual rules for entering multiple commands. The backslash appears only in
the first column, and semicolons separate the commands.

When you use the ! version of the command, whether in text lines or
command lines, the backslash always stays with the exclamation point.

Advertising
This manual is related to the following products: