Come costruire pagine web commentare con Visual Studio

November 11

Come costruire pagine web commentare con Visual Studio


Microsoft e altri sviluppatori di software consiglia di commentare il codice. documentazione del codice ti aiuta a capire il software che si crea. Si assiste anche i programmatori che possono mantenere la vostra 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 incorporare i tuoi commenti all'interno dell'applicazione. Dopo aver compilato il progetto, chiunque può visualizzare i commenti in una pagina Web.

istruzione

Crea progetto

1 Aprire Visual Studio. Selezionare "File" e "New Project" per aprire la finestra "Nuovo progetto".

2 Fai clic su "Visual C #" per evidenziarlo e fare doppio clic su "Applicazione Web ASP.NET."

3 Tipo "My_Website" nella casella di testo "Nome" e fare clic su "OK". Visual Studio creerà un nuovo progetto denominato "My_Website" e visualizzare i suoi file di progetto nel pannello Esplora soluzioni. Si vedrà un file chiamato "Default.aspx" in Esplora soluzioni. Questa la pagina principale del sito.

4 Fare clic sulla freccia accanto a "Default.aspx" e fare doppio clic su "Default.aspx.cs." Questo file contiene il codice C # della pagina.

5 Fare doppio clic su "Default.aspx.cs." Visual Studio verrà visualizzato il codice nella finestra del codice. Si vedrà un metodo denominato "Load" che assomiglia a questo:

protetto 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 ();

Questo chiama un altro metodo denominato computePrice. Dopo l'aggiunta di codice, il metodo sarà simile a questa:

protetto void Page_Load (object sender, EventArgs e)

{

int carPrice = computePrice ();

}

7 Aggiungere il seguente metodo dopo l'ultimo carattere staffa del metodo precedente:

private int computePrice () {

int Baseprice = 20000;

int fiscale = 1800;

int TotalPrice = Baseprice + tasse;

tornare TotalPrice;

}

Questo metodo calcola un prezzo totale con un prezzo base e una tassa di vendita. Il metodo non ha commenti per questo punto.

8 Posizionare il cursore del mouse sopra "int computerPrice privato () {" e di tipo "///" (senza le virgolette). Premere Invio." Visual Studio convertirà i tre caratteri di barra nel seguente blocco di testo:

/// <Summary>

///

/// </ Summary>

/// <Returns> </ returns>

Il testo che si inserisce all'interno di 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:

/// <Summary>

/// Questo metodo calcola un prezzo totale con un prezzo base e una tassa di vendita.

/// </ Summary>

/// <Returns> Il metodo restituisce il prezzo totale al metodo chiamante. </ Returns>

La sezione "sintesi" ora descritto il metodo e la sezione "restituisce" descrive il tipo di variabile che restituisce il metodo.

Vedi commento pagina Web

10 Individuare il progetto "My_Website" in Solution Explorer "e destro del mouse. Selezionare" Proprietà "per aprire il progetto" finestra delle proprietà ".

11 Fare clic sulla scheda "Crea" e mettere un segno di spunta accanto a "file di documentazione XML."

12 Fai clic su "Sfoglia". Esplora risorse si apre e visualizza il progetto "percorso di uscita." Questa è la posizione in cui Visual Studio memorizzerà il progetto compilato.

13 Individuare la barra degli indirizzi nella parte superiore di Esplora risorse di Windows. Si vedrà un percorso della cartella. E 'di solito simile a questa:

myUserAccount \ Documenti \ Visual Studio 2010 \ Project \ My_Website \ MyWebsite \ bin

Il percorso effettivo può essere diverso sul computer.

14 Pulsante destro del mouse su un'area vuota nella barra degli indirizzi e selezionare "Copia indirizzo". Windows copierà il percorso della clipboard. Fai clic su "Annulla" per chiudere Esplora risorse.

15 Spostare a Esplora soluzioni e fare clic destro "My_Website." Selezionare "Build". Visual Studio verrà compilare il progetto e creare un file XML contenente i tuoi commenti.

16 Fare clic sul pulsante del menu di Windows "Start" e fare clic con il casella "Cerca" nella parte inferiore del menu Start. Selezionare "Incolla". Windows incollare il percorso che è stato copiato nella casella "Cerca".

17 Premere Invio." 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 quindi selezionare "Internet Explorer". Internet Explorer si apre e visualizza una pagina Web che mostra i tuoi commenti.

Consigli e avvertenze

  • Gli sviluppatori di solito aggiungere blocchi di commento prima dell'inizio delle lezioni, i metodi, le proprietà e altri oggetti che essi creano.
  • Per interrompere Visual Studio di generare file di commento XML, tornare alla finestra "Proprietà" del progetto e rimuovere il segno di spunta dalla casella di controllo "file di documentazione XML".