beckhoff TE1030 TwinCAT 3 — 7.3.3 Example

Markups 7.3 Markup descriptions The individual markups are described in more detail below and there are examples of the written-out normal form and the abbreviated form in each case. 7.3.1 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: //! Text block that will be marked as description. Multi-line comment: (*! This is a description. A return value is named here. *) Abbreviated form: //!@description This could be a description of a code element. 7.3.2 Summary This markup element can be used to mark a text as a summary of a code element. Within the summary you are allowed to use additional markups.

In contrast to the description, however, the summary only exists once per program organization unit. All other places where you use the markup are not output in the documentation. Therefore, write the summary as a coherent text block. Example Normal form: //! This is the summary of the description in normal form. Abbreviated form: //!@summary This is the summary of the description in the abbreviated form. 7.3.3 Example The Example markup can be used to mark a text block as an example. Examples can be written in various places in the code. In the generated documentation, the examples are then displayed one below the other under the heading Example.

Thus, the examples can be written at the places in the code where they make sense and do not have to be contiguous at the beginning or end. Additional markups may be used within Examples. There is no abbreviated form for this markup. TE1030 18 Version: 1.3.3