Übersicht

Im Folgenden finden Sie eine Übersicht über die Markups, die für die Dokumentationserstellung gebraucht werden.

Normalform

Abgekürzte Form

Kontext

Beschreibung

<description> </description>

@description

 

Textabschnitt als Beschreibung gekennzeichnet.

<summary> </summary>

@summary

 

Textabschnitt als Zusammenfassung gekennzeichnet.

<example> </example>

@example

 

Textabschnitt als Beispiel formatiert.

<h1> </h1> - <h6> </h6>

-

description, summary, example

Überschriften bis Ebene 6

<code> </code>

@code

description, summary, example

Abschnitt mit Quellcode

<literal> </literal>

@literal

description, summary, example

Klartext, der nicht interpretiert werden soll.

-

$crossreference

description, summary, example

Querverweis

<see uri=“”> </see>

@see

description, summary, example

Link innerhalb eines Textabschnitts

<seealso uri=“”> </seealso>

@seealso

description, summary, example

Link außerhalb eines beliebigen Textabschnitts

<param name=“”> </param>

@param

 

Parameterwert

<ul> </ul>

@ul

description, summary, example

Definiert eine ungeordnete Liste.

<ol> </ol>

@ol

description, summary, example

Definiert eine nummerierte Liste.

<li> </li>

-

description, summary, example

Element einer Liste

<table> </table>

-

description, summary, example

Definiert eine Tabelle ähnlich wie bei HTML.

<th> </th>

-

description, summary, example

Erzeugt eine Tabelle mit Kopfzeile.

<tr> </tr>

-

description, summary, example

Erzeugt eine Tabellenreihe.

<td> </td>

-

description, summary, example

Erzeugt eine Tabellenspalte.

<audience> </audience>

-

 

Definiert eine Benutzergruppe für den markierten Textabschnitt.

<preliminary></preliminary>

@preliminary

 

Markiert einen Abschnitt als änderungsbedürftig.

<note type=“”> </note>

-

description, summary, example

Definiert Sicherheitshinweise (Gefahr, Warnung, Hinweis).

<image uri=""></image>

-

description, summary, example

Bindet ein Bild ein.