Markups

Im folgenden Kapitel geht es um die Markups, die dazu dienen, die Dokumentation zu erstellen. Die zur Dokumentationserstellung verwendeten Markups sind XML-basiert.

Beispiel

//!<description> Dies ist eine Beschreibung. </description>

Abgekürzte Formen der Tags

Wenn ein Dokumentationselement nur die Länge einer Zeile hat, kann die abgekürzte Form verwendet werden. In dieser Form werden die XML-Tags ohne eckige Klammern und schließende Elemente geschrieben. Anstelle der Klammern wird ein führendes @ zur Markierung der Tags verwendet.

Beispiel

Normalform:

//!<summary> Zusammenfassung durch Verwendung der Normalform </summary>

Abgekürzte Form:

//!@summary Zusammenfassung durch Verwendung der abgekürzten Form