COMMENT (Comment)

The COMMENT tag adds comment text to the generated panel or message member.

Syntax


>>-<COMMENT--+-------------------+-->--+--------------+--------->
             |       .-END-----. |     '-comment-text-'   
             '-TYPE=-+-CCSID---+-'                        
                     +-PANEL---+                          
                     +-ATTR----+                          
                     +-ABCINIT-+                          
                     +-ABCPROC-+                          
                     +-INIT----+                          
                     +-REINIT--+                          
                     +-PROC----+                          
                     +-HELP----+                          
                     +-PNTS----+                          
                     '-LIST----'                          

>--+------------+----------------------------------------------><
   '-</COMMENT>-'

Parameters

This attribute specifies the section of the panel that is to contain the comment text. The default is END. TYPE=END is assumed if the COMMENT tag is used within the MSGMBR tag.

COMMENT tags that specify the TYPE as ABCINIT or ABCPROC must follow an ABC or PDC tag.

When a COMMENT tag is coded within a HELP panel, the TYPE value is limited to CCSID, PANEL, ATTR, INIT, PROC, or END.

comment-text

The comment-text is flowed to a width of 66 bytes. The conversion utility adds "/* " before and " */" after the resulting text.

When no comment-text is present, a blank comment line is added to the specified (or defaulted) panel section.

Comments

The COMMENT tag adds comments to the generated ISPF format panel. If the PREP conversion option has been specified, the comments are not part of the final panel because they are not processed by the ISPPREP utility.

Lines of text from a COMMENT tag are added to the specified panel section when encountered in the DTL source file.

Note: If the panel section specified is not generated by other conversion processing, comments are formatted in this way:

TYPE: Position of comments
CCSID: Following the )PANEL statement.
LIST: Before the )END statement.

Comments added to the )END panel section are placed following any entries from the COPYR tag and comments containing the ISPDTLC version number and panel creation date. Lines placed in the )END section of a HELP panel are added to each continuation HELP panel.

Restrictions

You must code the COMMENT tag within an ABC, AREA, CHOICE, DA, DTACOL DTAFLD, HELP, LSTCOL, LSTFLD, LSTGRP, PANEL, PDC, REGION or SELFLD tag definition.

Processing

None.

Examples

Here is source file markup that contains a comment of several lines that are placed after the )END panel statement. Figure 1 shows portion of the ISPF format panel containing the formatted result.

<!doctype dm system>
<!-- COMMENT tag example - PANEL tag -->
<!--   )END section - after CMDAREA tag  -->

<varclass name=vc1 type='char 10'>
<varclass name=vc2 type='char 6'>
<varlist>
<vardcl name=lst1 varclass=vc1>
<vardcl name=lst2 varclass=vc2>
</varlist>

<panel name=comment1 depth=19 width=50>
This is panel Comment1

<LSTFLD >
<LSTGRP headline=yes>
<LSTCOL colwidth=10 datavar=lst1 usage=in varclass=vc1 line=1
        required=yes autotab=yes align=end help=h1 msg=abcd101>COL1
<LSTCOL colwidth=6  datavar=lst2 usage=in varclass=vc2 line=2
        required=yes autotab=yes align=end help=h1 msg=abcd101>COL2
</LSTGRP>
</LSTFLD>
<cmdarea>
<comment type=end>
  comment line 1
    comment line 2
      comment line 3
  comment line 4
    comment line 5
      comment line 6
  comment line 7
    comment line 8
      comment line 9
</panel>

Figure 1. Comment text added to a panel

⋮
)END
/* comment line 1 comment line 2 comment line 3 comment line 4        */
/* comment line 5 comment line 6 comment line 7 comment line 8        */
/* comment line 9                                                     */