Sdílet prostřednictvím


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.

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

Poznámka

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

Viz také