Character formats
Sie können verschiedene Zeichenformate für Ihre Dokumentation verwenden. Diese orientieren sich bei TwinCAT Documentation Generation an der HTML-Konvention.
Fett
Sie haben die Möglichkeit einzelne Ausdrücke in einem Text fett zu kennzeichnen. Das funktioniert, indem Sie das Markup <b> verwenden.
Beispiel:
(*!<description> In der folgenden Beschreibung wird ein Wort <b>fett</b> dargestellt. </description>*)
Kursiv
Sie haben die Möglichkeit einzelne Ausdrücke in einem Text kursiv zu kennzeichnen. Das funktioniert, indem Sie das Markup <i> verwenden.
Beispiel:
(*!<description> In der folgenden Beschreibung wird ein Wort <i>kursiv</i> dargestellt. </description>*)
Code
Sie haben die Möglichkeit einzelne Variablenausdrücke in einem Text als Code zu kennzeichnen. Das funktioniert, indem Sie das Markup <c> verwenden.
Beispiel:
(*!<description> Die Variable <c>iCount</c> wird jetzt mit diesem Textblock zusammen formatiert. <code>iCount:=iCount+1;</code> </description>*)
Unterstrichen
Sie haben die Möglichkeit einzelne Ausdrücke in einem Text zu unterstreichen. Das funktioniert, indem Sie das Markup <u> verwenden.
Beispiel:
(*!<description> In der folgenden Beschreibung wird ein Wort <u>unterstrichen</u>. </description>*)