Share via

Uw code documenteren met XML (Visual Basic)

  • Artikel

In Visual Basic kunt u uw code documenteer met behulp van XML.

Opmerkingen bij XML-documentatie

Visual Basic biedt een eenvoudige manier om automatisch XML-documentatie voor projecten te maken. U kunt automatisch een XML-skelet voor uw typen en leden genereren en vervolgens samenvattingen, beschrijvende documentatie voor elke parameter en andere opmerkingen opgeven. Met de juiste installatie wordt de XML-documentatie automatisch verzonden naar een XML-bestand met dezelfde hoofdbestandsnaam als uw project. Zie de optie -doc compiler en de eigenschap GenerateDocumentationFile MSBuild voor informatie over het configureren van het genereren van het XML-documentatiebestand.

Het XML-bestand kan worden gebruikt of anderszins worden bewerkt als XML. Dit bestand bevindt zich in dezelfde map als het uitvoerbestand .exe of .dll bestand van uw project.

XML-documentatie begint met '''. De verwerking van deze opmerkingen heeft enkele beperkingen:

  • De documentatie moet een goed opgemaakte XML zijn. Als de XML niet goed is opgemaakt, wordt er een waarschuwing gegenereerd en bevat het documentatiebestand een opmerking waarin staat dat er een fout is opgetreden.

  • Ontwikkelaars kunnen hun eigen set tags maken. Er is een aanbevolen set tags (zie XML Comment Tags). Sommige van de aanbevolen tags hebben speciale betekenissen:

    • De <parametertag> wordt gebruikt om parameters te beschrijven. Als deze wordt gebruikt, controleert de compiler of de parameter bestaat en of alle parameters worden beschreven in de documentatie. Als de verificatie mislukt, geeft de compiler een waarschuwing.

    • Het cref kenmerk kan worden gekoppeld aan elke tag om een verwijzing naar een code-element op te geven. De compiler controleert of dit code-element bestaat. Als de verificatie mislukt, geeft de compiler een waarschuwing. De compiler respecteert ook eventuele Imports instructies bij het zoeken naar een type dat in het cref kenmerk wordt beschreven.

    • De <samenvattingstag> wordt gebruikt door IntelliSense in Visual Studio om aanvullende informatie weer te geven over een type of lid.

Zie de volgende onderwerpen voor meer informatie over het maken van een XML-bestand met documentatieopmerkingen:

Zie ook