Udostępnij za pośrednictwem


Jak: tworzenie dokumentacji XML w języku Visual Basic

W tym przykładzie przedstawiono sposób dodawania komentarzy dokumentacji XML w kodzie.

[!UWAGA]

Na danym komputerze mogą być używane inne nazwy lub lokalizacje pewnych elementów interfejsu użytkownika programu Visual Studio, które są używane w poniższych instrukcjach. Używana wersja programu Visual Studio oraz jej ustawienia określają te elementy. Aby uzyskać więcej informacji, zobacz Visual Studio, ustawienia.

Aby utworzyć plik dokumentacji XML dla typu lub członka

  1. W Edytor kodu, umieść kursor w wierszu powyżej typu lub członka, dla którego chcesz utworzyć dokumentacji.

  2. Typ ''' (trzy znaki pojedynczego cudzysłowu).

    Szkielet XML dla typu lub członka dodaje się w Edytor kodu.

  3. Dodać opisowe informacje między odpowiednie znaczniki.

    [!UWAGA]

    Jeśli możesz dodać dodatkowe wiersze w bloku dokumentacji XML, każdy wiersz musi rozpoczynać się '''.

  4. Dodaj dodatkowy kod, który używa typu lub członka z nowych komentarzy dokumentacji XML.

    Technologia IntelliSense wyświetla tekst z <summary> tag dla typu lub członka.

  5. Skompiluj kod, aby wygenerować plik XML zawierający komentarze dokumentacji.Aby uzyskać więcej informacji, zobacz /doc.

Zobacz też

Informacje

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

/doc

Koncepcje

Dokumentowanie kod XML (Visual Basic)