Share via

Dokumentera koden med XML (Visual Basic)

  • Artikel

I Visual Basic kan du dokumentera koden med hjälp av XML.

Kommentarer till XML-dokumentation

Visual Basic är ett enkelt sätt att automatiskt skapa XML-dokumentation för projekt. Du kan automatiskt generera ett XML-skelett för dina typer och medlemmar och sedan tillhandahålla sammanfattningar, beskrivande dokumentation för varje parameter och andra kommentarer. Med rätt konfiguration skickas XML-dokumentationen automatiskt till en XML-fil med samma rotfilnamn som projektet. Information om hur du konfigurerar genereringen av XML-dokumentationsfilen finns i kompilatoralternativet -doc och egenskapen GenerateDocumentationFile MSBuild.

XML-filen kan användas eller på annat sätt manipuleras som XML. Den här filen finns i samma katalog som utdata .exe eller .dll fil i projektet.

XML-dokumentationen börjar med '''. Bearbetningen av dessa kommentarer har vissa begränsningar:

  • Dokumentationen måste vara välformulerad XML. Om XML-koden inte är väl utformad genereras en varning och dokumentationsfilen innehåller en kommentar om att ett fel påträffades.

  • Utvecklare kan skapa en egen uppsättning taggar. Det finns en rekommenderad uppsättning taggar (se XML-kommentarstaggar). Några av de rekommenderade taggarna har särskilda betydelser:

    • Param-taggen <> används för att beskriva parametrar. Om den används verifierar kompilatorn att parametern finns och att alla parametrar beskrivs i dokumentationen. Om verifieringen misslyckas utfärdar kompilatorn en varning.

    • Attributet cref kan kopplas till valfri tagg för att ge en referens till ett kodelement. Kompilatorn verifierar att det här kodelementet finns. Om verifieringen misslyckas utfärdar kompilatorn en varning. Kompilatorn respekterar även alla Imports instruktioner när du letar efter en typ som beskrivs i attributet cref .

    • Sammanfattningstaggen <> används av IntelliSense i Visual Studio för att visa ytterligare information om en typ eller medlem.

Mer information om hur du skapar en XML-fil med dokumentationskommentar finns i följande avsnitt:

Se även