Zalecane tagi XML dla komentarzy dokumentacji (Visual Basic)

Kompilator języka Visual Basic może przetwarzać komentarze dokumentacji w kodzie do pliku XML. Aby przetworzyć plik XML w dokumentacji, możesz 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 zawierać komentarze XML, chociaż nie ma żadnych ograniczeń dotyczących komentowania jego elementów członkowskich.

Uwaga / Notatka

Nie można zastosować komentarzy dokumentacji do przestrzeni nazw. Przyczyną 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ątek>¹
• <uwzględnij>¹
• <lista>
• <para>
• <param>¹
• <paramref>
• <uprawnienie>¹
• <Uwagi>
• <Zwraca>
• <zobacz>¹
• <seealso>¹
• <streszczenie>
• <typeparam>¹
• <typeparamref>
• <wartość>

(¹ Kompilator weryfikuje składnię).

Uwaga / Notatka

Jeśli chcesz, aby nawiasy kątowe pojawiały się w tekście komentarza 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 także

• Dokumentowanie kodu przy użyciu kodu XML
• -Doc
• Instrukcje: tworzenie dokumentacji XML