Sdílet prostřednictvím


Jak: vytvoření dokumentace XML v jazyce Visual Basic

Tento příklad ukazuje postup přidání komentářů dokumentace XML kódu.

[!POZNÁMKA]

Ve vašem počítači se pro některé z prvků uživatelského rozhraní sady Visual Studio mohou zobrazit jiné názvy a umístění, než jsou uvedeny v následujících pokynech. Tyto prvky jsou určeny verzí aplikace Visual Studio a použitým nastavením. Další informace naleznete v tématu Nastavení aplikace Visual Studio.

K vytvoření dokumentace XML pro typ nebo člen

  1. V Editor kódu, umístěte kurzor na řádek nad typ nebo člen, pro které chcete vytvořit dokumentaci.

  2. Typ ''' (tři single-uvozovky).

    Kostra XML pro typ nebo člen bude přidán do Editor kódu.

  3. Přidáte popisné informace mezi příslušné značky.

    [!POZNÁMKA]

    Pokud chcete přidat další řádky v rámci bloku dokumentace XML, každý řádek musí začínat '''.

  4. Přidejte další kód, který používá typ nebo člen s nových komentářů dokumentace XML.

    Technologie IntelliSense je zobrazen text <summary> značka pro typ nebo člen.

  5. Kompilace kódu generovat soubor XML obsahující komentáře k dokumentaci.Další informace naleznete v tématu /doc.

Viz také

Referenční dokumentace

Doporučené značky XML pro komentáře k dokumentaci (Visual Basic)

/doc

Koncepty

Dokumentování kódu XML (Visual Basic)