Zalecane tagi XML dla komentarzy dokumentacji (Visual Basic)

Kompilator Visual Basic może przetwarzać komentarze dokumentacji w kodzie do pliku XML. Do przetworzenia pliku XML w dokumentacji można użyć dodatkowych narzędzi.

Komentarze XML są dozwolone w konstrukcjach kodu, takich jak typy i składowe typów. W przypadku typów częściowych tylko jedna część typu może mieć komentarze XML, chociaż nie ma żadnych ograniczeń dotyczących komentowania jego elementów członkowskich.

Uwaga

Nie można zastosować komentarzy dokumentacji do przestrzeni nazw. Powodem jest to, że jedna przestrzeń nazw może obejmować kilka zestawów, a nie wszystkie zestawy muszą być ładowane w tym samym czasie.

Kompilator przetwarza dowolny tag, który jest prawidłowym kodem XML. Poniższe tagi udostępniają często używane funkcje w dokumentacji użytkownika.

• <C>
• <Kod>
• <Przykład>
• <wyjątek1>
• <include1>
• <Listy>
• <para>
• <param1>
• <paramref>
• <uprawnienie1>
• <Uwagi>
• <Zwraca>
• <zobacz1>
• <seealso1>
• <Krótki opis>
• <typeparam1>
• <Wartość>

(¹ Kompilator weryfikuje składnię).

Uwaga

Jeśli chcesz, aby nawiasy kątowe pojawiały się w tekście komentarza do dokumentacji, użyj znaków < i >. Na przykład ciąg "<text in angle brackets>" będzie wyświetlany jako <text in angle brackets>.

Zobacz też

• Dokumentowanie kodu za pomocą XML
• -doc
• Instrukcje: tworzenie dokumentacji XML