Sdílet prostřednictvím

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

  • Článek

Visual Basic Kompilátoru můžete zpracovat dokumentaci komentáře v kódu do souboru XML.Zpracovat soubor XML do dokumentace můžete použít další nástroje.

Komentáře XML jsou povoleny na konstrukce kódu, například typy a zadejte členů.Částečných typů mít pouze jednu část typu komentáře XML sice bez omezení na přidávání poznámek svých č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 všechna sestavení mají být načteny najednou.

Kompilátor zpracovává každý tag, který je platný kód XML.Následující značky poskytují běžně používané funkce v uživatelské dokumentaci.

<c>

<code>

<example>

<exception>1

<include>1

<list>

<para>

<param>1

<paramref>

<permission>1

<remarks>

<returns>

<see>1

<seealso>1

<summary>

<typeparam>1

<value>

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

[!POZNÁMKA]

Lomené závorky v text komentáře dokumentaci, použijte &lt; a &gt;.Například řetězec "&lt;text in angle brackets&gt;" se zobrazí jako <text in anglebrackets>.

Viz také

Úkoly

Jak: vytvoření dokumentace XML v jazyce Visual Basic

Referenční dokumentace

/doc

Koncepty

Dokumentování kódu XML (Visual Basic)