Delen via


Aanbevolen XML-tags voor opmerkingen bij documentatie (Visual Basic)

De Visual Basic-compiler kan documentatieopmerkingen in uw code verwerken naar een XML-bestand. U kunt extra hulpprogramma's gebruiken om het XML-bestand te verwerken in documentatie.

XML-opmerkingen zijn toegestaan voor codeconstructies, zoals typen en typeleden. Voor gedeeltelijke typen kan slechts één deel van het type XML-opmerkingen bevatten, hoewel er geen beperking is voor het maken van opmerkingen bij de leden.

Opmerking

Opmerkingen bij documentatie kunnen niet worden toegepast op naamruimten. De reden hiervoor is dat één naamruimte meerdere assembly's kan omvatten en niet alle assembly's tegelijkertijd moeten worden geladen.

De compiler verwerkt een tag die geldige XML is. De volgende tags bieden veelgebruikte functionaliteit in gebruikersdocumentatie.

(1 De compiler controleert de syntaxis.)

Opmerking

Als u hoekhaken wilt weergeven in de tekst van een opmerking in de documentatie, gebruikt &lt; u en &gt;. De tekenreeks "&lt;text in angle brackets&gt;" wordt bijvoorbeeld weergegeven als <text in angle brackets>.

Zie ook