Udostępnij za pośrednictwem


Porady: tworzenie dokumentacji XML w Visual Basic

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

[!UWAGA]

Na komputerze w poniższych instrukcjach mogą być wyświetlane inne nazwy i lokalizacje niektórych elementów interfejsu użytkownika programu Visual Studio. Te elementy są określane przez numer wersji Visual Studio oraz twoje ustawienia. Aby uzyskać więcej informacji, zobacz Dostosowywanie ustawień środowiska deweloperskiego w Visual Studio.

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 tagi XML dla komentarzy dokumentacji (Visual Basic)

/doc

Koncepcje

Dokumentowanie kodu za pomocą XML (Visual Basic)