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

Kompilátor 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 povolené u konstruktorů kódu, jako jsou typy a členy typů. U částečných typů může mít pouze jedna část typu komentáře XML, i když neexistuje žádné omezení pro přidávání komentářů ke svým členům.

Poznámka

Komentáře k dokumentaci nelze použít u oborů 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ýjimka1>
• <include1>
• <Seznamu>
• <Para>
• <param1>
• <paramref>
• <oprávnění1>
• <Poznámky>
• <Vrátí>
• <viz>¹
• <seealso1>
• <Shrnutí>
• <typeparam1>
• <Hodnotu>

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

Poznámka

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

Viz také

• Dokumentace kódu s XML
• -doc
• Postupy: Vytvoření dokumentace XML