Example

Das Markup Example kann verwendet werden, um einen Textblock als Beispiel zu markieren. Beispiele können im Code an verschiedenen Stellen geschrieben werden. In der generierten Dokumentation werden die Beispiele dann unter der Überschrift Example untereinander dargestellt. Die Beispiele können also an den Stellen des Codes geschrieben werden, an denen sie Sinn ergeben und müssen nicht zusammenhängend am Anfang oder Ende stehen.

Innerhalb von Examples dürfen weitere Markups verwendet werden. Es gibt keine abgekürzte Form für dieses Markup.

Beispiel

Normalform:

(*!<example>Dies ist die Beschreibung des folgenden Beispiels:

<code>iCount:=iCount+1;</code>

In diesem Beispiel wird die Erhöhung der Variablen $iCount um 1 angezeigt.</example>*)