Param

Das Markup Param erlaubt es, einen Parameterwert von z.B. Variablendeklarationen zu beschreiben. Es kann optional verwendet werden, wenn der Platz hinter der Parameterdefinition im Deklarationseditor nicht ausreicht, oder um die komplette Dokumentation an der gleichen Stelle zu haben.

Der Param steht für sich alleine und muss nicht in eine Description, eine Summary oder ein Example eingebunden werden. Durch das Markup Param erzeugen Sie eine Tabelle, in der die Variablen und ihre Werte aufgeführt werden.

Beispiel

Normalform:

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

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

PROGRAM MAIN

VAR_OUTPUT

    fFloatVar : REAL;

    iCount2 :INT;

    END_VAR

Abgekürzte Form:

//!@param fFloatVar Some float var

//!@param iCount2 Some count var

In der Dokumentation sieht das so aus: