Rekommenderade XML-taggar för dokumentationskommentar (Visual Basic)

Visual Basic-kompilatorn kan bearbeta dokumentationskommentarer i koden till en XML-fil. Du kan använda ytterligare verktyg för att bearbeta XML-filen i dokumentationen.

XML-kommentarer tillåts i kodkonstruktioner som typer och typmedlemmar. För partiella typer kan endast en del av typen ha XML-kommentarer, även om det inte finns någon begränsning för att kommentera dess medlemmar.

Anmärkning

Det går inte att använda dokumentationskommenter på namnområden. Orsaken är att ett namnområde kan sträcka sig över flera sammansättningar och att inte alla sammansättningar måste läsas in samtidigt.

Kompilatorn bearbetar alla taggar som är giltiga XML- Följande taggar innehåller vanliga funktioner i användardokumentationen.

(1 Kompilatorn verifierar syntax.)

Anmärkning

Om du vill att vinkelparenteser ska visas i texten i en dokumentationskommentare använder du &lt; och &gt;. Strängen "&lt;text in angle brackets&gt;" visas till exempel som <text in angle brackets>.

Se även