Param

The markup Param allows to describe a parameter value of e.g. variable declarations. It can be used optionally if there is not enough space behind the parameter definition in the declaration editor, or to have the complete documentation in the same place.

The Param stands alone and does not need to be included in a Description, Summary or Example. The markup Param allows you to create a table in which the variables and their values are listed.

Example

Normal form:

//!<param name="fFloatVar">Some float var</param>

//!<param name="iCount2">Some count var</param>

PROGRAM MAIN

VAR_OUTPUT

    fFloatVar : REAL;

    iCount2 :INT;

    END_VAR

Abbreviated form:

//!@param fFloatVar Some float var

//!@param iCount2 Some count var

In the documentation it looks like this: