Description

This markup element is used to mark a text block as a description. Description blocks can be created in various places in the code. In the documentation generated, the individual description blocks are then combined into one text block. So the documentation can be written at the places of the PLC code where it fits and does not have to be at the beginning or end.

The markup description additionally serves as a @mantel element and is accordingly required to be able to use various other elements for the documentation. Other markups can also be used in the abbreviated form of the Description markup.

Example

Normal form:

Single-line comment:

//!<description> Text block that will be marked as description. </description>

Multi-line comment:

(*!<description>This is a description.

<returns> A return value is named here. </returns>

</description>*)

Abbreviated form:

//!@description This could be a description of a code element.