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

Tento příklad ukazuje, jak do kódu přidat komentáře dokumentace XML.

Poznámka:

Počítač může v následujících pokynech zobrazit různé názvy nebo umístění některých prvků uživatelského rozhraní sady Visual Studio. Edice sady Visual Studio, kterou máte, a nastavení, která používáte, určují tyto prvky. Další informace najdete v tématu Přizpůsobeníintegrovaného vývojového prostředí (IDE).

Vytvoření dokumentace XML pro typ nebo člena

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

2. Typ ''' (tři jednoduché uvozovky).

   V editoru kódu se přidá kostra XML pro typ nebo člen.

3. Mezi příslušné značky přidejte popisné informace.

   Poznámka:

   Pokud do bloku dokumentace XML přidáte další řádky, musí každý řádek začínat '''.

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

   IntelliSense zobrazí text ze značky <summary> pro typ či člena.

5. Zkompilujte kód pro vygenerování souboru XML obsahujícího komentáře dokumentace. Další informace viz -doc.

Viz také

• Zdokumentování kódu pomocí XML
• Značky komentářů XML
• -dokument