Udostępnij za pośrednictwem

Zalecane tagów XML dla komentarzy dokumentacji (Visual Basic)

  • Artykuł

Visual Basic Kompilator może przetwarzać komentarzy dokumentacji w kodzie do pliku XML.Dodatkowe narzędzia można użyć do przetworzenia pliku XML na dokumentacji.

Komentarze są dozwolone w konstrukcje kodu, takie jak typy i wpisz członków.Dla typów częściowych tylko jedna część tego typu może mieć komentarze, mimo że nie ma ograniczeń na komentowanie swoich członków.

[!UWAGA]

Nie można zastosować komentarzy dokumentacji do obszarów nazw.Powodem jest, że jeden obszar nazw może obejmować kilka zestawów, a nie wszystkie zespoły muszą być ładowane w tym samym czasie.

Kompilator przetwarza każdy znacznik, który jest prawidłowy dokument XML.Następujące znaczniki udostępniają często używane funkcje w dokumentacji użytkownika.

<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 Kompilator sprawdza składnię.)

[!UWAGA]

Nawiasy w tekst komentarzy dokumentacji, należy użyć &lt; i &gt;.Na przykład ciąg "&lt;text in angle brackets&gt;" pojawią się jako <text in anglebrackets>.

Zobacz też

Zadania

Jak: tworzenie dokumentacji XML w języku Visual Basic

Informacje

/doc

Koncepcje

Dokumentowanie kod XML (Visual Basic)