Microsoft e altri sviluppatori di software raccomanda di commentare il codice. Documentazione del codice aiuta a capire il software che si crea. Si assiste anche i programmatori che possono mantenere l'applicazione in futuro. Programma di Visual Studio di Microsoft semplifica il processo di documentazione del software . Basta aggiungere testo XML al codice, e il software inserire i tuoi commenti all'interno dell'applicazione . Dopo aver compilato il progetto , chiunque può visualizzare i tuoi commenti su una pagina web.
Istruzioni Creare Progetto
1
Aprire Visual Studio . Selezionare " File" e "New Project" per aprire la finestra "Nuovo progetto" .
2
Clicca " Visual C #" per evidenziarlo e fare doppio clic su " Applicazione Web ASP.NET . " < Br >
3
tipo " My_Website " nella casella di testo "Nome" e fare clic su " OK ". Visual Studio verrà creato un nuovo progetto denominato " My_Website " e visualizzare i suoi file di progetto nel pannello di Esplora soluzioni. Vedrete un file chiamato " Default.aspx " in Esplora soluzioni . Questa è la pagina principale del sito.
4
Fare clic sulla freccia accanto al doppio clic su " Default.aspx " e " Default.aspx.cs . " Questo file contiene il codice della pagina C # .
5
doppio clic su " Default.aspx.cs . " Visual Studio verrà visualizzato il codice nella finestra del codice . Vedrete un metodo denominato " Page_Load " che assomiglia a questo :
protected void Page_Load ( object sender, EventArgs e) {
}
questo metodo viene eseguito quando un browser carica la pagina
6
Aggiungere la seguente riga di codice tra i due caratteri di parentesi :
int carPrice = computePrice ();
< p . > Questo chiama un altro metodo denominato computePrice . Dopo l'aggiunta di codice , il metodo sarà simile a questa :
protected void Page_Load ( object sender, EventArgs e) {
int carPrice = computePrice ( ) ;
}
7
Aggiungere il seguente metodo dopo l'ultimo carattere parentesi del metodo precedente :
private int computePrice ( ) {
int basePrice = 20000 ; < br
int imposta > = 1800 ;
int TotalPrice = basePrice + IVA;
ritorno TotalPrice ;
}
Questo metodo calcola un totale prezzo con un prezzo base e una tassa di vendita . Il metodo non ha alcun commento , a questo punto .
8
Posizionare il cursore del mouse sopra "int computerPrice privato ( ) { " e digitare " ///" ( senza le virgolette) . Premere il tasto " Enter ". Visual Studio permette di convertire i tre caratteri di barra nel seguente blocco di testo :
///
///Games
///< /summary >
/// < /returns >
il testo immesso in questo blocco apparirà nei commenti XML della pagina web . Questo blocco di codice ha un posto per mettere una sintesi del metodo e il tipo di valore che il metodo restituisce
9
modificare il blocco di codice in modo che assomiglia a questo : .
///Games ///Questo metodo calcola un prezzo totale con un prezzo base e una tassa di vendita .
///< /summary >
< p > /// il metodo restituisce il prezzo totale al metodo chiamante . < /returns >
la sezione "Riepilogo " ora descritto il metodo e la sezione " restituisce" descrive il tipo di variabile che il metodo restituisce .
Vedi il commento Pagina Web
10
individuare il progetto " My_Website " nel Solution Explorer "e fare clic destro . Selezionare " Proprietà "per aprire la finestra "Proprietà" del progetto.
11
Fare clic sulla scheda "costruire" e mettere un segno di spunta accanto a " file di documentazione XML . "
12
Fare clic su " Sfoglia . "Windows Explorer si apre e visualizza il progetto " Percorso di uscita . "Questo è il luogo in cui Visual Studio verrà memorizzare il progetto compilato .
13
Individuare la barra degli indirizzi nella parte superiore di Esplora risorse di Windows . si vedrà un percorso di cartella E di solito simile a questa : .
myUserAccount \\ Documenti \\ Visual Studio 2010 \\ Progetto \\ My_Website \\ MyWebsite \\ bin
Il percorso effettivo può essere diverso sul computer < . br> Pagina 14
pulsante destro del mouse su un'area vuota della barra degli indirizzi e selezionare " Copia indirizzo ". Windows copierà il percorso nei tuoi appunti. Cliccare su " Annulla " per chiudere Esplora risorse.
15
Sposta in Esplora soluzioni e fare clic destro " My_Website . " Select "Build ". Visual Studio compila il progetto e creare un file XML che contiene i tuoi commenti .
16
Clicca Windows tasto menu e fare clic con il dialogo " Cerca " nella parte inferiore del menu di avvio "Start" . selezionare "Incolla ". Windows incollare il percorso che è stato copiato nella casella " Cerca".
17 < p > Premere il tasto " Enter ". Esplora risorse si apre e visualizza il contenuto della cartella che contiene il progetto compilato .
18
Individuare " My_Website.XML " e fare clic destro il file . Selezionare "Apri con "e poi selezionare " Internet Explorer ". Internet Explorer si apre e visualizza una pagina Web che mostra i vostri commenti.
