Microsoft und anderen Software-Entwickler empfehlen kommentierte Code. Code-Dokumentation hilft Ihnen, die Software, die Sie erstellen. Es hilft auch Programmierer, die Ihre Anwendung in der Zukunft zu sichern kann . Microsoft Visual Studio -Programm vereinfacht die Software-Dokumentation Prozess . Fügen Sie einfach XML-Text , um Ihren Code , und die Software wird Ihre Kommentare in der Anwendung einbetten. Nach dem Kompilieren des Projekts , kann jeder einen Kommentar auf einer Webseite anzuzeigen. Anleitung
Projekt erstellen
1
Öffnen Sie Visual Studio. Wählen Sie " Datei" und " New Project" , die " New Project" Fenster zu öffnen.
2
Klicken Sie auf " Visual C # ", um es zu markieren, und doppelklicken Sie auf " ASP.NET Web Application . "
3
Type " Meine_Website " im Feld "Name " Textfeld und klicken Sie auf "OK". Visual Studio erstellt ein neues Projekt mit dem Namen " Meine_Website " und zeigen ihre Projekt-Dateien im Explorer angezeigt. Sie werden sehen, eine Datei mit dem Namen " Default.aspx " im Solution Explorer . Dies ist die Website der Hauptseite.
4
Klicken Sie auf den Pfeil neben " Default.aspx " und doppelklicken Sie auf " Default.aspx.cs . " Diese Datei enthält die Seite der C #-Code .
5
Doppelklicken Sie auf " Default.aspx.cs . " Visual Studio wird der Code im Code-Fenster anzuzeigen. Sie werden sehen, eine Methode namens " Page_Load " , die wie folgt aussieht:
protected void Page_Load (object sender, EventArgs e) {
}
Diese Methode wird ausgeführt, wenn ein Browser die Seite lädt
6
Fügen Sie die folgende Codezeile zwischen den beiden Klammer-Zeichen :
int carPrice = computePrice ();
< p . > Diese ruft eine andere Methode mit dem Namen computePrice . Nach Hinzufügen von Code , wird das Verfahren wie folgt aussehen:
protected void Page_Load (object sender, EventArgs e) {
int carPrice = computePrice ();
}
7
Fügen Sie die folgende Methode nach dem bisherigen Verfahren die letzte Klammer :
private int computePrice () { int
Grundpreis = 20000 ;
int Steuern = 1800 ;
int totalPrice = Grundpreis + MwSt.;
Rückkehr totalPrice ;
}
Diese Methode errechnet insgesamt Preis mit einem Basispreis und eine Umsatzsteuer . Das Verfahren hat noch keine Kommentare zu diesem Zeitpunkt .
8
Position Ihren Mauszeiger über "private int computerPrice () {" und geben Sie " ///" (ohne die Anführungszeichen ) . Drücken Sie "Enter". Visual Studio werden die drei Schrägstrich in der folgenden Textblock zu konvertieren:
///
///Tablet
///
///
Text , den Sie eingeben innerhalb dieses Blocks in der Web-Seite der XML-Kommentare erscheinen. Dieser Code -Block hat einen Platz , um eine Zusammenfassung der Methode und die Art der Wert, den die Methode zurückgibt
9
den Code -Block , so dass es so aussieht Ändern setzen : .
///
///Diese Methode errechnet einen Gesamtpreis mit einem Basispreis und eine Umsatzsteuer .
///
< p > /// die Methode gibt den Gesamtpreis an die aufrufende Methode .
der Abschnitt "Zusammenfassung" beschreibt nun das Verfahren und die "Erträge" Abschnitt beschreibt die Art der variablen dass die Methode zurückgibt .
Ansicht Kommentar Webseite
10
Suchen Sie die " Meine_Website "-Projekt im Solution Explorer " und der rechten Maustaste darauf . Wählen Sie" Eigenschaften ", um des Projekts öffnen Sie die "Eigenschaften "-Fenster.
11
Klicken Sie auf " Erstellen " und setzen Sie ein Häkchen neben " XML-Dokumentation -Datei. "
12
Klicken Sie auf "Durchsuchen . "Windows Explorer wird geöffnet und zeigt das Projekt " Output Path. "Dies ist der Ort, an dem Visual Studio das kompilierte Projekt gespeichert werden.
13
Suchen Sie die Adressleiste an der Spitze der Windows Explorer. Sie einen Pfad sehen, es wird in der Regel wie folgt aussehen: .
myUserAccount \\ Documents \\ Visual Studio 2010 \\ Project \\ Meine_Website \\ mywebsite \\ bin
Der tatsächliche Pfad kann auf Ihrem Computer unterscheiden < . br> 14
der rechten Maustaste auf einen leeren Bereich in der Adressleiste und wählen Sie " Adresse kopieren. " Windows wird der Pfad in die Zwischenablage zu kopieren. klicken Sie auf " Abbrechen", um den Windows Explorer zu schließen.
15
Move to -Explorer mit der rechten Maustaste " Meine_Website . " Select "Build . " Visual Studio kompiliert das Projekt und erstellen Sie eine XML -Datei mit Ihren Kommentaren.
16
Klicken Sie im Windows " Start"-Menü -Taste und der rechten Maustaste auf den "Suchen" -Feld unten im Startmenü . Wählen Sie " einfügen". Windows den Pfad, den Sie in das Feld "Suchen" kopiert haben .
17 < p> Taste "Enter . " Windows Explorer wird geöffnet und zeigt den Inhalt des Ordners, die kompilierte Projekt enthält .
18
Suchen " My_Website.XML " und der rechten Maustaste auf diese Datei . Wählen Sie "Öffnen Mit " und wählen Sie dann " Internet Explorer . "Internet Explorer wird geöffnet und zeigt eine Webseite, die Ihre Kommentare zeigt .
