Commenting a report
To comment a report, add some lines starting with #+, before the report
body. The comment body is composed of paragraphs separated by a blank line. The first
paragraph of the comment is a short description of the report. This description will be
placed in the function summary table. The next paragraph is long text describing the
report 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 report. |
@param name
description |
Defines a report parameter identified by name, explained by a description. name must match the parameter name in the report declaration. |