Commenting a module constant
The comment body is composed of paragraphs separated by a blank line. 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 the paragraph; a tag starts
with @
(the "at" sign).
Tag | Description |
---|---|
@code |
Indicates that the next lines show a code example using the constant. |
Example
#+ This is the constant Pi
#+
#+ To be used in trigo computing
#+
#+ @code
#+ DISPLAY util.Math.cos( Pi / 2 )
#+
PUBLIC CONSTANT Pi = 3.14159