Commenting a module type

To document a module type definition, add #+ lines just before the TYPE declaration.

The comment body is composed of paragraphs separated by blank lines. The first paragraph of the comment is a short description of the type. This description will be placed in the type summary table. The next paragraph is long text describing the type in detail. Other paragraphs must start with a tag to identify the type of paragraph; a tag starts with the @ "at" sign.

Table 1. Supported @ tags
Tag Description
@code Indicates that the next lines show a code example using the type.


#+ This is the customer type
#+ Define variables with this type to hold customer records.
#+ @code
#+ DEFINE myvar t_cust
              cust_num INTEGER,
              cust_name VARCHAR(50),
              cust_addr VARCHAR(100)
            END RECORD