Empfohlene XML-Tags für Dokumentationskommentare (Visual Basic)

  • Artikel

Der Visual Basic-Compiler kann Dokumentationskommentare im Code zu einer XML-Datei verarbeiten. Sie können zusätzliche Tools verwenden, um die XML-Datei zu Dokumentationsmaterial zu verarbeiten.

XML-Kommentare sind für Codekonstrukte wie Typen und Typenmember zulässig. Bei partiellen Typen kann nur ein Teil des Typs über XML-Kommentare verfügen. Allerdings gibt es keine Einschränkungen für das Kommentieren seiner Member.

Tipp

Dokumentationskommentare können nicht auf Namespaces angewendet werden. Dies liegt daran, dass sich ein Namespace über mehrere Assemblys erstrecken kann. Außerdem müssen nicht alle Assemblys gleichzeitig geladen werden.

Der Compiler verarbeitet jedes Tag, das gültiges XML darstellt. Die folgenden Tags stellen in Benutzerdokumentationen häufig verwendete Funktionen bereit:

<c>

<code>

<example>

<exception>1

<include>1

<list>

<para>

<param>1

<paramref>

<permission>1

<remarks>

<returns>

<see>1

<seealso>1

<summary>

<typeparam>1

<value>

(1 Der Compiler überprüft Syntax.)

Tipp

Wenn ein Dokumentationskommentar spitze Klammern enthalten soll, verwenden Sie &lt; und &gt;. So wird zum Beispiel die Zeichenfolge "&lt;text in angle brackets&gt;" als <text in angle brackets> angezeigt.

Siehe auch

Aufgaben

Gewusst wie: Erstellen einer XML-Dokumentation in Visual Basic

Referenz

/doc

Konzepte

Dokumentieren von Code mit XML (Visual Basic)