Aanbevolen XML-tags voor opmerkingen bij documentatie (Visual Basic)
De Visual Basic compiler kan documentatieopmerkingen in uw code verwerken in een XML-bestand. U kunt aanvullende hulpprogramma's gebruiken om het XML-bestand in documentatie te verwerken.
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 toevoegen van opmerkingen aan de leden.
Notitie
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 elke tag die geldige XML is. De volgende tags bieden veelgebruikte functionaliteit in gebruikersdocumentatie.
- <C>
- <Code>
- <Voorbeeld>
- <uitzondering1>
- <include1>
- <list>
- <Para>
- <param1>
- <paramref>
- <machtiging1>
- <Opmerkingen>
- <Retourneert>
- <see1>
- <seealso1>
- <Samenvatting>
- <typeparam1>
- <Waarde>
(1 De compiler controleert de syntaxis.)
Notitie
Als u punthaken wilt weergeven in de tekst van een opmerking bij de documentatie, gebruikt < u en >. De tekenreeks "<text in angle brackets>" wordt bijvoorbeeld weergegeven als <text in angle brackets>.