Microsoft och andra mjukvaruutvecklare rekommenderar kommentera din kod . Kod dokumentation hjälper dig att förstå den programvara som du skapar . Det hjälper också programmerare som kan behålla din ansökan i framtiden . Microsofts Visual Studio programmet förenklar processen dokumentationen till programvaran . Lägg helt enkelt till XML- text i koden , och programmet kommer att bädda dina kommentarer inne i programmet . Efter sammanställning av projektet , kan vem som helst se dina synpunkter på en webbsida . Instruktioner Review, Skapa Project
1
Öppna Visual Studio . Välj " File " och " New Project" för att öppna " New Project "-fönstret .
2
Klicka på " Visual C # " för att markera den och dubbelklicka på " ASP.NET Web Application . "
3
Type " My_Website " i " Name " textrutan och klicka på " OK . " Visual Studio kommer att skapa ett nytt projekt som heter " My_Website " och visa dess projektfiler i Solution Explorer panelen . Du kommer att se en fil som heter " Default.aspx " i Solution Explorer . Detta är webbplatsens huvudsida .
4
Klicka på pilen bredvid " Default.aspx " och dubbelklicka på " Default.aspx.cs . " Denna fil innehåller sidans C # -kod . " . Default.aspx.cs "
5
Dubbelklicka på Visual Studio kommer att visa sin kod i koden fönstret . Du kommer att se en metod som heter " Page_Load " som ser ut så här :
skyddade void Page_Load ( objekt avsändare , EventArgs e ) katalog
{
}
denna metod körs när en webbläsare laddar sidan
6
Lägg till följande kodrad mellan de två hakparentes :
int carPrice = computePrice ( ) ;
< p . > Detta kräver en annan metod som heter computePrice . Efter tillsats av koden , kommer metoden se ut så här :
skyddade void Page_Load ( objekt avsändare , EventArgs e ) katalog
{
int carPrice = computePrice ( ) ;
}
7
Lägg följande metod efter den tidigare metoden sista fäste tecknet :
private int computePrice ( ) {
int basePrice = 20000 ;
int skatt = 1800 ;
int totalPrice = basePrice + skatt ,
retur totalPrice ,
}
Denna metod beräknar en total pris med ett grundpris och en omsättningsskatt . Metoden har inga kommentarer på den här punkten .
8
Placera muspekaren ovanför " private int computerPrice ( ) { " och typ " ///" ( utan citationstecknen ) . Tryck på " Enter ". Visual Studio kommer att omvandla de tre snedstreck i följande textblocket :
///
///
///< /summary >
/// < /avkastning >
text som du anger i detta block kommer att visas i webbsidans XML kommentarer . Denna kod block har en plats att sätta en sammanfattning av metoden och den typ av värde som metoden returnerar
9
Ändra koden blocket så att det ser ut så här : .
///
///Denna metod beräknar ett totalpris med ett grundpris och en omsättningsskatt .
///< /summary >
/// metoden returnerar det totala priset till den anropande metoden . < /avkastning >
" sammanfattning" avsnittet nu beskriver metoden och den " avkastning " avsnittet beskriver vilken typ av variabel att metoden returnerar .
View Kommentar webbsida
10
Leta upp " My_Website " projektet i Solution Explorer " och högerklicka på det . välj" Egenskaper " till öppna projektet " Egenskaper " fönstret .
11
Klicka på " Build " -fliken och sätta en bock bredvid " XML dokumentation . "
12
Klicka " Bläddra . " Windows Utforskaren öppnas och visar projektets " Output Path . " Detta är den plats där Visual Studio kommer att lagra den kompilerade projektet .
13
Leta adressfältet överst i Windows Explorer . Du kommer att se en sökväg Det brukar kommer se ut så här : .
myUserAccount \\ Documents \\ Visual Studio 2010 \\ Projekt \\ webbplats \\ myWebsite \\ bin
själva banan kan skilja på din dator < . br >
14
Högerklicka på ett tomt område i adressfältet och välj " Kopiera adress . " Windows kommer att kopiera sökvägen till Urklipp . klicka på " Avbryt " för att stänga Windows Explorer .
15
Flytta till Solution Explorer och högerklicka på " My_Website . " Select " Build . " Visual Studio kommer att kompilera projektet och skapa en XML -fil som innehåller dina kommentarer .
16
Klicka på Windows " Start " meny-knappen och högerklicka på " Sök " rutan längst ner i Start-menyn . Välj " klistra in . " Windows kommer att klistra in banan som du kopierade i "Sök " rutan .
17
Tryck " Enter . " Windows Utforskaren öppnas och visar innehållet i den mapp som innehåller den kompilerade projektet .
18
Leta " My_Website.XML " och högerklicka på filen . Välj " Open med " och välj sedan " Internet Explorer . " Internet Explorer öppnas och visar en webbsida som visar dina kommentarer .
