Microsoft og andre software -udviklere anbefaler kommentere din kode . Kode dokumentationen hjælper dig med at forstå den software , som du opretter . Det hjælper også programmører, der kan opretholde din ansøgning i fremtiden. Microsofts Visual Studio program forenkler dokumentationen til softwaren proces. Du skal blot tilføje XML tekst til din kode , og softwaren vil integrere dine kommentarer inde i programmet . Efter udarbejdelsen af projektet , kan alle se dine kommentarer på en webside. Instruktioner
Opret projekt
1
Open Visual Studio. Vælg "File " og " Nyt projekt " for at åbne " Nyt projekt " vinduet.
2
Klik på " Visual C # " for at fremhæve det, og dobbeltklik på " ASP.NET Web Application . " < Br >
3
Type " Mit_Websted " i "Navn" tekstfeltet, og klik "OK". Visual Studio vil oprette et nyt projekt med navnet " Mit_Websted ", og vise dets projektfiler i Solution Explorer panel. Du vil se en fil med navnet " Default.aspx " i Solution Explorer . Dette er hjemmesidens forside.
4
Klik på pilen ved siden af " Default.aspx ", og dobbeltklik på " Default.aspx.cs ". Denne fil indeholder sidens C # kode.
5
Dobbeltklik på " Default.aspx.cs ". Visual Studio vil vise sin kode i koden vinduet. Du vil se en metode ved navn " Page_Load ", der ser sådan ud : Hej
protected void Page_Load (object sender, EventArgs e )
{
}
denne metode kører når en browser indlæser siden
6
Tilføj følgende linje kode mellem de to beslag karakterer : Hej
int carPrice = computePrice ();
< p . > Dette kalder en anden metode ved navn computePrice . Efter tilsætning kode, vil metoden se således ud:
protected void Page_Load (object sender, EventArgs e )
{
int carPrice = computePrice ();
}
7
Tilføj følgende metode, efter den tidligere metode sidste beslag karakter : Hej
private int computePrice () {
int Basispris = 20000 ; < br >
int skat = 1800 ;
int totalprice = Basispris + afgiften;
tilbagevenden totalprice ,
}
Denne metode beregner en total pris ved hjælp af en basispris og en omsætningsafgift . Metoden har ingen kommentarer på nuværende tidspunkt .
8
Position musemarkøren over " private int computerPrice () {" og skriv " ///" (uden anførselstegn) . Tryk på " Enter". Visual Studio vil konvertere de tre skråstreg figurer i følgende tekstblok : Hej
///
///
///
/// < /returnerer >
tekst , som du indtaster i denne blok vil vises i websidens XML bemærkninger. Denne kode blok har et sted at sætte et sammendrag af metoden og den type værdi, som metoden returnerer
9
Rediger kodeblokken så det ser sådan ud: .
///
///Denne metode beregner en samlet pris ved hjælp af en basispris og en omsætningsafgift .
///
< p > /// metoden returnerer den samlede pris til den kaldende metode. < /returnerer >
" summary" afsnittet nu beskriver metoden og " returnerer" afsnit beskriver typen af variable at metoden returnerer .
View Kommentar webside
10
Find " Mit_Websted "-projektet i Solution Explorer ", og højreklik på det . vælg" Egenskaber "til åbne projektets "Egenskaber " vinduet.
11
Klik på " Build " fanen og sætte et flueben ud for "XML dokumentation . "
12
tryk "Gennemse . "Windows Stifinder åbnes og viser projektets " Output Path. "Dette er det sted, hvor Visual Studio gemmer kompileret projekt.
13
Find adresselinjen øverst i Windows Stifinder. du vil se en mappesti Det vil normalt se således ud: .
myUserAccount \\ Documents \\ Visual Studio 2010 \\ Projekt \\ Mit_Websted \\ mywebsite \\ bin
faktiske sti kan være anderledes på din computer < . br >
14
Højreklik på et tomt område i adresselinjen og vælg " Copy -adresse. " Windows vil kopiere stien til din udklipsholder. klik på " Cancel " for at lukke Windows Stifinder.
15
Flyt til Solution Explorer og højreklik " Mit_Websted . " Vælg " Bygn. " Visual Studio vil udarbejde projektet og oprette en XML- fil, der indeholder dine kommentarer.
16
Klik på Windows "Start" menu-knappen , og højreklik på "Søg "-boksen nederst i Start-menuen. Vælg " indsæt". Windows indsætte den sti, du har kopieret ind i "Søg "-boksen.
17 < p> Tryk på " Enter. " Windows Stifinder åbnes og viser indholdet af den mappe, der indeholder det kompileret projekt.
18
Find " My_Website.XML " og højreklik filen . Vælg "Åbn med "og derefter vælge" Internet Explorer ". Internet Explorer vil åbne og vise en webside, der viser dine kommentarer .
