Microsoft en andere software -ontwikkelaars raden commentaar uw code . Code documentatie helpt u de software die u maakt te begrijpen. Het helpt ook programmeurs die kan uw applicatie in de toekomst te behouden . Visual Studio -programma van Microsoft vereenvoudigt de software documentatie proces . Voeg eenvoudig XML-tekst aan uw code , en de software zal uw commentaar insluiten in de toepassing . Na het opstellen van het project , kan iedereen uw reacties bekijken op een webpagina . Instructies
Maak Project
Open Visual Studio 1 . Selecteer " File " en " New Project" op de "Project Nieuw" venster te openen . Kopen van 2 Klik op " Visual C # " om het te markeren en dubbelklik op " ASP.NET Web Application . " < Br >
Type 3 " Mijn_website " in de "Naam" tekstvak en klik op "OK . " Visual Studio zal een nieuw project met de naam " Mijn_website " maken en haar project bestanden weer te geven in de Verkenner paneel Solution . Je zal een bestand met de naam " Default.aspx " in de Solution Explorer te zien . Dit is de hoofdpagina van de website .
4 Klik op de pijl naast " Default.aspx " en dubbelklik op " Default.aspx.cs . " Dit bestand bevat de pagina 's C # code .
5 Dubbelklik op " Default.aspx.cs . " Visual Studio zal de code in het code-venster weer te geven . Je zal een methode genaamd " Page_Load " die er als volgt uitziet :
beschermde nietige Page_Load (object , _EventArgs_e ) op Twitter {
}
deze methode wordt uitgevoerd wanneer een browser laadt de pagina
6 Voeg de volgende regel code tussen de twee beugel personages :
int carPrice = computePrice ( ) ;
Deze andere methode genaamd computePrice noemt . Na het toevoegen van code , zal de methode er als volgt uit :
beschermde nietige Page_Load (object , _EventArgs_e ) op Twitter {
int carPrice = computePrice ( ) ;
}
7 Voeg de volgende methode na de vorige methode 's laatste beugel karakter : private int computePrice (
) {
int basePrice = 20000 ; < br int belasting > = 1800 ;
int totaalprijs = basePrice + belasting ; terugkeer totaalprijs
; }
Deze methode berekent een totaal prijs met een basisprijs en een omzetbelasting . De methode heeft geen commentaar op dit punt.
Plaats uw muiscursor boven " private int computerPrice ( ) { " 8 en type " ///" ( zonder de aanhalingstekens ) . Druk op " Enter ". Visual Studio zal de drie slash tekens omzetten in het volgende tekstblok : /// /// ///< /summary >
/// < /returns > tekst
die u invoert binnen dit blok zal verschijnen in XML- opmerkingen van de webpagina 's . Deze code blok heeft een plek om een samenvatting van de methode en de aard van de waarde die de methode retourneert
9 Wijzig de code blok , zodat het lijkt alsof deze gezet : .
///
///Deze methode berekent een totale prijs met een basisprijs en een omzetbelasting .
///< /summary >
/// de methode retourneert de totale prijs voor het bellen methode . < /returns >
de rubriek "Samenvatting " beschrijft nu de methode en de sectie " rendement " beschrijft het type variabele dat de methode retourneert .
Reactie webpagina
10 Zoek de " Mijn_website " -project in de Solution Explorer " en klik met de rechtermuisknop . Selecteer" Eigenschappen "om Open venster "Eigenschappen " van het project .
11 Klik op het tabblad " Build " en zet een vinkje naast " XML documentatiemap . "
12 Klik op " Bladeren . " zal Windows Verkenner openen en het project " Output Path . "Dit is de locatie waar Visual Studio het gecompileerde project zal slaan .
13 Zoek de adresbalk bovenaan in Windows Verkenner . U zal een pad te zien Het zal meestal zo uitzien : . myUserAccount \\ Documents \\ Visual Studio 2010 \\ Project \\ Mijn_website \\ Mijnwebsite \\ bin
De werkelijke pad kan afwijken op uw computer < . br >
14 met de rechtermuisknop op een leeg gebied in de adresbalk en selecteer " adres kopiëren . " Windows zal het pad naar het klembord te kopiëren . klik op " Annuleren " om Windows Verkenner sluiten .
Move 15 aan de Solution Explorer en klik met de rechtermuisknop " Mijn_website . " Selecteer " Build . " Visual Studio zal het project te compileren en creëren een XML- bestand met uw opmerkingen.
16 Klik op de Windows- "Start " menu-knop en het vak aan de onderkant van het menu Start met de rechtermuisknop op "Zoeken " . Selecteer "Plakken . " Windows zal het pad dat u hebt gekopieerd in het vak "Zoeken " plakken .
17 Druk op ' Enter '. Windows Verkenner wordt geopend en de inhoud van de map waarin de gecompileerde project bevat .
18 Locate " My_Website.XML " en met de rechtermuisknop op het bestand . Selecteer " Open met " en kies vervolgens " Internet Explorer . " Internet Explorer opent en toont een webpagina met uw commentaar laat zien .
|
