Freigeben über


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

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

XML-Kommentare sind für Codekonstrukte wie Typen und Typmmber zulässig. Bei Teiltypen kann nur ein Teil des Typs XML-Kommentare enthalten, obwohl es keine Einschränkung beim Kommentieren seiner Member gibt.

Hinweis

Dokumentationskommentare können nicht auf Namespaces angewendet werden. Der Grund dafür ist, dass ein Namespace mehrere Assemblys umfassen kann und nicht alle Assemblys gleichzeitig geladen werden müssen.

Der Compiler verarbeitet jedes Tag, das gültige XML ist. Die folgenden Tags stellen häufig verwendete Funktionen in der Benutzerdokumentation bereit.

(1 Der Compiler überprüft die Syntax.)

Hinweis

Wenn winkelige Klammern im Text eines Dokumentationskommentars angezeigt werden sollen, verwenden &lt; Und &gt;. Die Zeichenfolge "&lt;text in angle brackets&gt;" wird z. B. als <text in angle brackets>.

Siehe auch