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

Kompilátor jazyka Visual Basic může zpracovávat komentáře dokumentace v kódu do souboru XML. K zpracování souboru XML do dokumentace můžete použít další nástroje.

Komentáře XML jsou povoleny u konstruktorů kódu, jako jsou typy a členy typu. U částečných typů může mít pouze jedna část typu komentáře XML, i když neexistuje žádné omezení pro komentování členů.

Poznámka:

Komentáře k dokumentaci nelze použít pro obory názvů. Důvodem je, že jeden obor názvů může zahrnovat několik sestavení, a ne všechna sestavení musí být načtena současně.

Kompilátor zpracuje všechny značky, které jsou platné XML. Následující značky poskytují běžně používané funkce v uživatelské dokumentaci.

• <c>
• <kód>
• <příklad>
• <výjimka>¹
• <include>¹
• <seznam>
• <para>
• <param>¹
• <paramref>
• <oprávnění>¹
• <poznámky>
• <návraty>
• <viz>¹
• <seealso>¹
• <shrnutí>
• <typeparam>¹
• <typeparamref>
• <hodnota>

(¹ Kompilátor ověřuje syntaxi.)

Poznámka:

Pokud chcete, aby se v textu komentáře dokumentace zobrazovaly úhlové závorky, použijte < a >. Například řetězec "<text in angle brackets>" se zobrazí jako <text in angle brackets>.

Viz také

• Zdokumentování kódu pomocí XML
• -dokument
• Postupy: Vytvoření dokumentace XML