Het toevoegen van documentatie aan uw Visual Basic . NET ( VB.NET ) project is belangrijk, zodat mensen met behulp van het programma hebben een plaats om meer informatie over de mogelijkheden die ze hebben moeite met vinden . Visual Studio maakt gebruik van '' 'om een documentatie lijn , die het creëert automatisch een XML template voor betekenen . Wanneer u uw project te compileren , zal Visual Studio een XML- bestand maken van al uw documentatie opmerkingen. Wat je nodig hebt
Microsoft Visual Studio 2005 , 2008 of 2010
Toon Meer Aanwijzingen
1 Open uw VB.NET project in Microsoft Visual Studio 2005 , 2008 of 2010 . kopen van 2 Zoek de code voor een type of lid dat u wilt documenteren en plaats uw cursor op de regel boven de code . Een type omvat zaken zoals een interface of klasse . Leden omvatten dingen zoals een subroutine , functie , gebeurtenis of eigenschap .
3 Toevoegen '' ' ( 3 enkele offerte tekens ) aan het begin van de regel . Dit specificeert een documentatie- lijn . De code -editor zal een XML skelet overeenkomen met de elementen op de lijn eronder toevoegen.
4 Voeg uw documentatie als tekst tussen de XML -tags . Het is mogelijk om nieuwe XML- documentatie Reactie tags toe te voegen door het bewerken van de " VBXMLDOC.xml " bestand met een teksteditor . Het bestand bevindt zich in Visual Studio 's " Application Data " of de map " AppData " .
5 Voeg geen extra regels code met de XML- documentatie commentaren dat het type of lid te gebruiken . Een tag zal aanvullende informatie over het type of lid te tonen .
6 Klik uw project op de Solution Explorer . Klik op het menu " Project " en klik op "Eigenschappen . " Klik op het tabblad " Compile " en voeg " /doc " in het vak " Generate XML documentatiemap " . Dit vertelt de compiler om een XML- bestand aan te maken wanneer u het project te compileren .
7 Maak een XML- documentatie -bestand door het opstellen van uw VB.NET project . Het bestand wordt weergegeven in dezelfde map als je . Exe of . Dll-bestand .
|
