Microsoft og andre programvareutviklere anbefaler kommenterer din kode . Kode dokumentasjon hjelper deg å forstå programvaren som du oppretter. Det hjelper også programmerere som kan opprettholde søknaden din i fremtiden. Microsofts Visual Studio program forenkler dokumentasjonen for programvaren prosessen. Bare legg XML tekst i koden , og programvaren vil legge inn kommentarer inne i applikasjonen . Etter kompilering prosjektet, kan noen vise kommentarer på en webside. Instruksjoner , Lag Prosjekt
en
Åpne Visual Studio. Velg " File" og "New Project " for å åpne "New Project "-vinduet.
2
Klikk " Visual C #" for å markere det, og dobbeltklikk på " ASP.NET Web Application . "
3
Type " My_Website " i " Navn"-boksen og klikk " OK . " Visual Studio vil opprette et nytt prosjekt kalt " My_Website " og vise sine prosjekter i Solution Explorer panel . Du vil se en fil som heter " Default.aspx " i Solution Explorer . Dette er nettstedets hovedside.
4
Klikk på pilen ved siden av " Default.aspx " , og dobbeltklikk på " Default.aspx.cs . " Denne filen inneholder sidens C #-kode .
5
Dobbeltklikk på " Default.aspx.cs . " Visual Studio vil vise sin kode i koden vinduet. Du vil se en metode som heter " Page_Load " som ser slik ut : en
beskyttet ugyldig Page_Load ( objekt avsenderen , EventArgs e )
{
}
denne metoden kjøres når en nettleser laster siden
6
Legg til følgende linje med kode mellom de to klamme tegn : en
int carPrice = computePrice ();
< p . > Dette kaller en annen metode som heter computePrice . Etter å legge koden , vil metoden ser slik ut : en
beskyttet ugyldig Page_Load ( objekt avsenderen , EventArgs e )
{
int carPrice = computePrice ();
}
7
Legg til følgende metode etter den forrige metoden siste brakett karakter : en
private int computePrice ( ) {
int basePrice = 20000 ;
int skatt = 1800 ;
int totalPrice = basePrice + skatt ;
retur totalPrice ;
}
Denne metoden beregner en total pris ved hjelp av en grunnpris og en omsetningsavgift . Metoden har ingen kommentarer på dette punktet .
8
Hold musepekeren over "private int computerPrice ( ) {" og skriv " ///" ( uten anførselstegn ) . Trykk på " Enter". Visual Studio vil konvertere de tre slash tegn inn følgende tekst blokk : en
///
///
///< /oppsummering >
/// < /returnerer >
Teksten som du skriver i denne blokken vil vises i Web sidens XML kommentarer . Denne koden blokken har et sted å sette en oppsummering av metoden og den type verdi som metoden returnerer
9
Endre koden blokken slik at det ser slik ut: .
///
///Denne metoden beregner en samlet pris ved hjelp av en grunnpris og en omsetningsavgift .
///< /oppsummering >
< p > /// metoden returnerer den totale prisen til å kalle metoden. < /returnerer >
" Sammendrag" delen nå beskriver metoden og "tilbake "-delen beskriver hvilken type variabel at metoden returnerer .
Vis Kommentar Web Page
10
Finn " My_Website " prosjektet i Solution Explorer " og høyre -klikk på den . Velg" Properties "til åpne prosjektet er " Properties " vinduet .
11
Klikk på " Build "-fanen og sette en hake ved siden av "XML dokumentasjon fil . "
12
klikk på "Browse . "Windows Explorer åpner og viser prosjektets " Output Path. " Dette er stedet der Visual Studio vil lagre den kompilerte prosjektet .
13
Finn adresselinjen på toppen av Windows Explorer. Du vil se en mappe sti Det vil vanligvis ser slik ut : .
myUserAccount \\ Documents \\ Visual Studio 2010 \\ Prosjekt \\ My_Website \\ myWebsite \\ bin
selve banen kan være forskjellig på datamaskinen din < . br >
14
Høyreklikk et tomt område i adressefeltet og velg " Kopier adresse . " Windows vil kopiere banen til utklippstavlen. klikk på " Avbryt " for å lukke Windows Explorer.
15
Flytt til Solution Explorer og høyreklikk " My_Website . " Select "Bygg . " Visual Studio vil kompilere prosjektet og lage en XML-fil som inneholder dine kommentarer.
16
Klikk på Windows "Start "-menyen knappen og høyre -klikk på " Søk" boksen nederst på Start-menyen . Velg " lim inn. " Windows vil lime banen som du kopierte inn i " Søk" boksen .
17 < p> Trykk på "Enter . " Windows Explorer åpnes og vise innholdet i mappen som inneholder den kompilerte prosjektet .
18
Finn " My_Website.XML " og høyreklikk filen . Velg "Åpne med "og velg deretter " Internet Explorer . "Internet Explorer åpnes og vise en webside som viser dine kommentarer.
