Udostępnij przez

Porady: tworzenie dokumentacji XML w Visual Basic

  • Artykuł

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

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 Personalizowanie środowiska IDE.

Aby utworzyć dokumentację XML dla typu lub elementu członkowskiego

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

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

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

  3. Dodaj opisowe informacje między odpowiednimi tagami.

    Uwaga

    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 elementu członkowskiego.

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

Zobacz też