HP 3000 Manuals

VIRTUOSO CODE GENERATOR Reference Manual

#comment 

Provides in-line documentation for source statements.

Syntax 

     #comment   text

Description 

This construct allows you to document a model or macro.  The text forming
the comment follows the #comment construct.  The comments serve only as
means of documenting statements.  The statements are not included in the
generated text; however, they are included in the Virtuoso source listing
file.

Examples 

EXAMPLE 1

     #comment
     #comment  The following commands retrieve all scripts that are being use
     #comment  for the current module.  The model expects only two scripts
     #comment  to be retrieved.
     #comment

The above example illustrates the use of the #comment construct.  It is
used here to describe the generator constructs that are used in the text
file.  The five #comment statements above generate no source code.

EXAMPLE 2

     #comment
     #comment  This Macro generates code to call DBPUT
     #comment
     #macro DBPut image-database="string"image-dataset="string"record="string"
     .
     .
     .

The above example illustrates the use of the #comment construct to
document a macro.

MPE/iX 5.0 Documentation