Dela via

Anvisningar: Skapa XML-dokumentation i Visual Basic

Det här exemplet visar hur du lägger till XML-dokumentationskommentarer i koden.

Anmärkning

Datorn kan visa olika namn eller platser för vissa av Visual Studio-användargränssnittselementen i följande instruktioner. Den Visual Studio-utgåva som du har och de inställningar som du använder avgör dessa element. Mer information finns i Anpassning av utvecklingsmiljön.

Skapa XML-dokumentation för en typ eller medlem

  1. Placera markören på raden ovanför den typ eller medlem som du vill skapa dokumentation för i kodredigeraren.

  2. Typ ''' (tre enkla citattecken).

    Ett XML-skelett för typen eller medlemmen läggs till i kodredigeraren.

  3. Lägg till beskrivande information mellan lämpliga taggar.

    Anmärkning

    Om du lägger till ytterligare rader i XML-dokumentationsblocket måste varje rad börja med '''.

  4. Lägg till ytterligare kod som använder typen eller medlemmen med de nya XML-dokumentationskommentarna.

    IntelliSense visar texten från taggen <summary> för typen eller medlemmen.

  5. Kompilera koden för att generera en XML-fil som innehåller dokumentationskommentarna. Mer information finns i -doc.

Se även

  • Last updated on