Übersicht
Im Folgenden finden Sie eine Übersicht über die Markups, die für die Dokumentationserstellung gebraucht werden.
Normalform | Abgekürzte Form | Beschreibung |
---|---|---|
<description> </description> | @description | Textabschnitt als Beschreibung gekennzeichnet. |
<summary> </summary> | @summary | Textabschnitt als Zusammenfassung gekennzeichnet. |
<example> </example> | - | Textabschnitt als Beispiel formatiert. |
<h1> </h1> - <h6> </h6> | - | Überschriften bis Ebene 6 |
<code> </code> | @code | Abschnitt mit Quellcode |
<literal> </literal> | @literal | Klartext, der nicht interpretiert werden soll. |
- | $crossreference | Querverweis |
<see uri=“”> </see> | @see | Link innerhalb eines Textabschnitts |
<seealso uri=“”> </seealso> | @seealso | Link außerhalb eines beliebigen Textabschnitts |
<param name=“”> </param> | @param | Parameterwert |
<returns> </returns> | @returns | Rückgabewert |
<ul> </ul> | @ul | Definiert eine ungeordnete Liste. |
<ol> </ol> | @ol | Definiert eine nummerierte Liste. |
<li> </li> | - | Element einer Liste |
<table> </table> | - | Definiert eine Tabelle ähnlich wie bei HTML. |
<audience> </audience> | - | Definiert eine Benutzergruppe für den markierten Textabschnitt. |
<preliminary></preliminary> | @preliminary | Markiert einen Abschnitt als änderungsbedürftig. |
<note type=“”> </note> | - | Definiert Sicherheitshinweise (Gefahr, Warnung, Hinweis). |
<image uri=""></image> | - | Bindet ein Bild ein. |