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 der Dokumentation zu verarbeiten.
XML-Kommentare sind auf Codekonstrukten wie Typen und Typmembern zulässig. Bei Teiltypen kann nur ein Teil des Typs XML-Kommentare enthalten, obwohl es keine Einschränkung für das Kommentieren seiner Member gibt.
Hinweis
Dokumentationskommentare können nicht auf einen Namespace 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 alle Tags, die gültige XML sind. Die folgenden Tags stellen häufig verwendete Funktionen in der Benutzerdokumentation 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 verifiziert Syntax.)
Hinweis
Wenn Sie möchten, dass im Text eines Dokumentationskommentars spitze Klammern erscheinen, verwenden Sie < und >. Beispielsweise wird die Zeichenfolge "<text in angle brackets>" als <text in angle brackets> angezeigt.