Sdílet prostřednictvím


Postupy: Vytvoření dokumentace XML v jazyce Visual Basic

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

[!POZNÁMKA]

Na vašem počítači se můžou v následujících pokynech zobrazovat jiné názvy nebo umístění některých prvků uživatelského rozhraní Visual Studia. Tyto prvky jsou určeny edicí sady Visual Studio a použitým nastavením. Další informace najdete v tématu Přizpůsobení nastavení pro vývoj v sadě 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 dokumentační komentáře (Visual Basic)

/doc

Koncepty

Dokumentace kódu s XML (Visual Basic)