Tilføjelse dokumentation til din Visual Basic NET ( VB.NET ) projekt er vigtigt , så folk bruger dit program har et sted at finde mere information om funktioner, de har problemer med . . Visual Studio bruger '' ' til at betyde et dokumentationsredskab linje, som den automatisk opretter en XML skabelon for . Når du kompilerer dit projekt, vil Visual Studio opretter en XML-fil fra alle dine dokumentation kommentarer . Ting du skal
Microsoft Visual Studio 2005, 2008 eller 2010
Vis Flere Instruktioner
1
Åbn din VB.NET projekt i Microsoft Visual Studio 2005, 2008 eller 2010 .
2
Find koden for en type eller et medlem , som du ønsker at dokumentere og placere markøren på linjen over koden. En type omfatter ting såsom en grænseflade eller klasse. Medlemmerne omfatter ting som en subrutine , funktion, begivenhed eller ejendom.
3
Tilføj '' ' ( 3 enkelt anførselstegn tegn) til begyndelsen af linjen. Dette angiver et dokumentationsredskab linje. Kodeksen Editor tilføjer en XML skelet , der svarer til de elementer på linjen nedenunder.
4
Tilføj din dokumentation som tekst mellem de XML-tags . Det er muligt at tilføje nye XML Dokumentation Kommentar tags ved at redigere " VBXMLDOC.xml " fil med en tekst editor. Filen ligger i Visual Studio er " Application Data " eller " AppData " mappe .
5.
Tilføj ekstra linjer kode med XML dokumentation kommentarer , der bruger typen eller medlem . En tag vil vise yderligere information om den type eller medlemmet.
6 Klik dit projekt på Solution Explorer . Klik på " Project" menuen og klik på " Egenskaber". Klik på " Compile " fanen og tilføje " /doc " i " Generer XML dokumentation " boksen. Dette fortæller compileren at oprette en XML-fil , når du kompilere projektet.
7
Opret en XML dokumentation ved at indsamle dit VB.NET projekt. Filen vil blive vist i den samme mappe som din . Exe eller . Dll-fil .