Literal

Das Markup <literal> kann verwendet werden, um Text als reinen Text zu kennzeichnen, der nicht interpretiert werden soll. Diese Funktion kann hilfreich sein, um innerhalb des Quellcodes der Dokumentation Anmerkungen zu machen.

Literal verwenden Sie innerhalb der Markups Description, Summary und Example.

Beispiel

Normalform:

//!<description> Diese Beschreibung enthält Text, der nicht interpretiert werden soll. Dieser folgt nun. <literal> Die Auszeichnung <b> fett </b> wird hier nicht interpretiert, sondern die Tags werden in die Dokumentation geschrieben. </literal> Hier folgt wieder Text, in dem die Auszeichnung <b> fett </b> interpretiert wird. </description>

Abgekürzte Form:

//!@description Diese Beschreibung enthält Text, der nicht interpretiert werden soll. Dieser folgt nun. @literal Die Auszeichnung <b> fett </b> wird hier nicht interpretiert, sondern die Tags werden in die Dokumentation geschrieben.