Udostępnij za pośrednictwem

Porady: tworzenie dokumentacji XML w Visual Basic

W tym przykładzie pokazano, jak dodać komentarze dokumentacji XML do kodu.

Uwaga / Notatka

Na komputerze mogą być wyświetlane różne nazwy lub lokalizacje niektórych elementów interfejsu użytkownika programu Visual Studio w poniższych instrukcjach. Wersja programu Visual Studio i ustawienia, których używasz, określają te elementy. Aby uzyskać więcej informacji, zobacz Personalizowanie środowiska IDE.

Aby utworzyć dokumentację XML dla typu lub członka

  1. W Edytorze kodu umieść kursor w wierszu powyżej typu lub elementu członkowskiego, dla którego chcesz utworzyć dokumentację.

  2. Typ ''' (trzy pojedyncze apostrofy).

    Szkielet XML dla typu lub elementu członkowskiego jest dodawany w Edytorze kodu.

  3. Dodaj opisowe informacje między odpowiednimi tagami.

    Uwaga / Notatka

    Jeśli dodasz dodatkowe wiersze w bloku dokumentacji XML, każdy wiersz musi zaczynać się od '''.

  4. Dodaj dodatkowy kod, który używa typu lub elementu członkowskiego z nowymi komentarzami dokumentacji XML.

    Funkcja IntelliSense wyświetla tekst z tagu <podsumowania> dla typu lub członka.

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

Zobacz także