Legge dokumentasjon til Visual Basic NET ( VB.NET ) prosjektet er viktig for at personer som bruker programmet ha et sted å finne mer informasjon om funksjonene de har problemer med . . Visual Studio bruker '' 'for å betegne en dokumentasjon linje, som det automatisk oppretter en XML mal for . Når du kompilere prosjektet , vil Visual Studio lage en XML-fil fra alle dine dokumentasjon kommentarer . Du trenger
Microsoft Visual Studio 2005, 2008 eller 2010
Vis flere instruksjoner
en
Åpne VB.NET prosjektet i Microsoft Visual Studio 2005, 2008 eller 2010 .
2
Finn kode for en type eller medlem som du ønsker å dokumentere og plasserer du markøren på linjen over koden . En type inkluderer ting som et grensesnitt eller klasse. Medlemmer inkluderer ting som en subrutine , funksjon , event eller eiendom .
3
Legg '' ' ( 3 enkle hermetegn tegn) til begynnelsen av linjen . Dette angir en dokumentasjon linje. The Code Editor legge til en XML- skjelett tilsvarer elementene på linjen under den.
4
Legg dokumentasjonen som tekst mellom XML-koder . Det er mulig å legge til nye XML Dokumentasjon Kommentar koder ved å redigere " VBXMLDOC.xml " fil med en tekst editor. Filen ligger i Visual Studio er " Application Data" eller " AppData " -mappen.
5
Legg noen ekstra linjer med kode med XML dokumentasjon kommentarer som bruker typen eller medlem . En tag vil vise mer informasjon om hvilken type eller medlem .
6 Klikk på ditt prosjekt på Solution Explorer . Klikk på "Project "-menyen og klikk " Egenskaper". Klikk på " Kompiler "-fanen og legg til " /doc " i " Generate XML dokumentasjon fil "-boksen. Dette forteller kompilatoren for å lage en XML-fil når du kompilere prosjektet.
7
Opprette en XML dokumentasjon fil ved å kompilere din VB.NET prosjektet. Filen vises i samme mappe som . Exe eller . Dll -fil .