Rekommenderade XML-taggar för dokumentationskommentar (Visual Basic)
Den Visual Basic kompilatorn kan bearbeta dokumentationskommentarer i koden till en XML-fil. Du kan använda ytterligare verktyg för att bearbeta XML-filen till dokumentationen.
XML-kommentarer tillåts för 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.
Anteckning
Det går inte att använda dokumentationskommentare för 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.
- <C>
- <Koden>
- <Exempel>
- <exception1>
- <include1>
- <Lista>
- <Para>
- <param1>
- <paramref>
- <permission1>
- <Anmärkningar>
- <Returnerar>
- <se1>
- <seealso1>
- <Sammanfattning>
- <typeparam1>
- <Värde>
(1 Kompilatorn verifierar syntax.)
Anteckning
Om du vill att vinkelparenteser ska visas i texten i en dokumentationskommentare använder du < och >. Strängen "<text in angle brackets>" visas till exempel som <text in angle brackets>.