Data Definition Language (DDL) Reference Manual

DDL Language Elements
Data Definition Language (DDL) Reference Manual—529431-004
2-14
Dictionary Comments
You can put user-defined dictionary comments in:
•
The Dictionary
The DDL compiler stores user-defined dictionary comments in the dictionary only if
the dictionary is open and comments are specifically requested by a COMMENTS
command. The DDL compiler stores any comments that follow a COMMENTS
command in the open dictionary. A NOCOMMENTS command causes the DDL
compiler to stop storing comments in the dictionary.
•
Source Code Files
If dictionary comments are stored in the dictionary, the DDL compiler automatically
reproduces these comments in any open C, COBOL, DDL, FORTRAN, Pascal (on
D-series systems), TACL, or TAL source code file. You can suppress the writing of
dictionary comments to any of these open source code files by entering the
NOCLISTOUT command. You can resume reproducing comments with a
CLISTOUT command.
•
The Compiler Listing
The DDL compiler puts all user-defined dictionary comments in its compiler listing
by default, whether or not the dictionary is open and whether or not you specify a
COMMENTS command. You can suppress the listing of dictionary comments by
issuing the NOCLISTIN command, and you can resume listing dictionary
comments by issuing a CLISTIN command.
Dictionary Comments Generated by the DDL Compiler
The DDL compiler generates dictionary comments that report the date and time the
schema was first compiled and the date and time each definition and record is
compiled. These timestamp comments are always added to the dictionary. They are
also added to any open source code files unless suppressed with the NOTIMESTAMP
command. A TIMESTAMP command causes the DDL compiler to add subsequent
timestamp comments to any open source code files.
Example 2-6. User-Defined Dictionary Comments
DEFINITION custinfo.
* This field is a unique customer identifier:
02 custnum PIC 9(4).
* This group has the customer name in sequence:
02 custname.
04 last-name PIC X(12).
04 first-name PIC X(8).
04 initial PIC X(2).
END