Commenting a module variable
To comment a module variable, add some lines starting with #+
, before the
variable definition (i.e. before the DEFINE
instruction. The comment body is
composed of paragraphs separated by a blank line. The first paragraph of the comment is a short
description of the variable. This description will be placed in the variable summary table. The next
paragraph is long text describing the variable in detail. Other paragraphs must start with a tag to
identify the type of the paragraph; a tag starts with the @ "at" sign.
Tag | Description |
---|---|
@code |
Indicates that the next lines show a code example using the variable. |
Example
#+ Customer array
#+
#+ Fill this array with customer records and use it
#+ in DISPLAY ARRAY to control a TABLE
#+
PUBLIC DEFINE cust_list DYNAMIC ARRAY OF RECORD
cust_num INTEGER,
cust_name VARCHAR(50),
cust_addr VARCHAR(100)
END RECORD