How to read the syntax diagrams

The following syntax diagram example shows the syntax for the #pragma comment directive. See Pragma Directives (#pragma) for information on the #pragma directive.


(1) (2)  (3)  (4)       (5)       (6)                             (9)   (10)
 >>--#--pragma--comment--(-------compiler---------------------------)----><
                          |                                     |
                          +-----date----------------------------+
                          |                                     |
                          +-----timestamp-----------------------+
                          |                                     |
                          +-----copyright-----------------------+
                             |             |  |                 |
                             +--user-------+  +--,-"characters"-+
 
                                                (7)     (8)

(1) This is the start of the syntax diagram.

(2) The symbol # must appear first.

(3) The keyword pragma must appear following the # symbol.

(4) The name of the pragma comment must appear following the keyword pragma.

(5) An opening parenthesis must be present.

(6) The comment type must be entered only as one of the types indicated: compiler, date, timestamp, copyright, or user.

(7) A comma must appear between the comment type copyright or user, and an optional character string.

(8) A character string must follow the comma. The character string must be enclosed in double quotation marks.

(9) A closing parenthesis is required.

(10) This is the end of the syntax diagram.

The following examples of the #pragma comment directive are syntactically correct according to the diagram shown above:

   #pragma comment(date)
   #pragma comment(user)
   #pragma comment(copyright,"This text will appear in the module")
 
IBM Copyright 2003