Commenting a module constant

To document a module constant definition, add #+ lines just before the CONSTANT declaration.

The comment body is composed of paragraphs separated by blank lines. The first paragraph of the comment is a short description of the constant. This description will be placed in the constant summary table. The next paragraph is long text describing the constant 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 constant.


#+ This is the constant Pi
#+ To be used in trigo computing
#+ @code
#+ DISPLAY util.Math.cos( Pi / 2 )