Description

Dieses Markup-Element dient der Kennzeichnung eines Textblocks als Beschreibung. Beschreibungsblöcke können im Code an verschiedenen Stellen erstellt werden. In der generierten Dokumentation werden die einzelnen Beschreibungsblöcke dann zu einem Textblock zusammengefügt. Die Dokumentation kann also an den Stellen des SPS-Codes geschrieben werden, an denen es passt und muss nicht am Anfang oder Ende stehen.

Das Markup Description dient zusätzlich als Mantelelement und wird entsprechend benötigt, um verschiedene andere Elemente für die Dokumentation nutzen zu können. Auch in der abgekürzten Form des Markups Description können weitere Markups verwendet werden.

Beispiel

Normalform:

Einzeiliger Kommentar:

//!<description> Textblock, der als Beschreibung gekennzeichnet wird. </description>

Mehrzeiliger Kommentar:

(*!<description>Dieses ist eine Beschreibung.

<returns> Hier wird ein Rückgabewert genannt. </returns>

</description>*)

Abgekürzte Form:

//!@description Dies könnte eine Beschreibung eines Code-Elements sein.