Visual Studio .NET-Übungsreihe: Übung 2

  • Artikel

Veröffentlicht: 20. Sep 2001 | Aktualisiert: 17. Jun 2004

In dieser Übung verwenden Sie den C#-Compiler, um aus XML-Kommentaren, die in eine C#-Quelldatei eingefügt wurden, eine XML- Datei (Extensible Markup Language) zu erzeugen. Mit Hilfe von XML-bezogenen Kommentarzeichen im C#-Code können Sie angeben, welche Kommentare in die XML-Datei ausgegeben werden sollen. Die XML-Datei kann dann als Dokumentation für den Code verwendet werden.
Auf dieser Seite

Einführung Einführung
Erstellen eines neuen Projekts in der IDE Erstellen eines neuen Projekts in der IDE
Erstellen der Quelldatei "XMLComment.cs" Erstellen der Quelldatei "XMLComment.cs"
Öffnen des Projekts und der Quelldatei in der IDE Öffnen des Projekts und der Quelldatei in der IDE
Kompilieren von Codebeispielen Kompilieren von Codebeispielen
Anwenden der XSL-Vorlage auf die XML-Datei Anwenden der XSL-Vorlage auf die XML-Datei
Öffnen der endgültigen Version von "Doc.xml" Öffnen der endgültigen Version von "Doc.xml"
Abschließen von Übung 2 Abschließen von Übung 2

Einführung

In dieser Übung verwenden Sie den C#-Compiler, um aus XML-Kommentaren, die in eine C#-Quelldatei eingefügt wurden, eine XML- Datei (Extensible Markup Language) zu erzeugen. Mit Hilfe von XML-bezogenen Kommentarzeichen im C#-Code können Sie angeben, welche Kommentare in die XML-Datei ausgegeben werden sollen.

Die XML-Datei kann als Dokumentation für den Code verwendet werden. Sie können neue Kommentare hinzufügen oder vorhandene Kommentare bearbeiten und so die Dokumentation an den entsprechenden Code anpassen. Wenn Sie einen aktualisierten Datensatz der Dokumentation erstellen möchten, generieren Sie die XML-Datei neu.

In dieser Übung lernen Sie Folgendes:

  1. Verwenden der integrierten Entwicklungsumgebung von Microsoft Visual Studio .NET (IDE), um Projektdateien zu erstellen und zu bearbeiten

  2. Erstellen einer XML-Datei (doc.xml)

  3. Öffnen des Projekts und der Quelldatei in der IDE

  4. Kompilieren des Beispiels unter Verwendung der MS-DOS-Eingabeaufforderung

  5. Anwenden einer XSL-Vorlage (Extensible Stylesheet Language) auf die XML-Datei

  6. Öffnen der endgültigen Version von Doc.xml

 

Erstellen eines neuen Projekts in der IDE

  1. Klicken Sie auf Start, Programme, Microsoft Visual Studio .NET und Microsoft Visual Studio .NET. Die IDE-Startseite wird wie in Abbildung 1 angezeigt

    expvs2

    Abbildung 1. Startseite in der IDE von Visual Studio .NETAnmerkung

    Die Startseite wird standardmäßig geöffnet, wenn Sie die IDE so starten. Auf dieser Seite finden Sie Links zu den letzten vier Projekten, an denen Sie in der Umgebung gearbeitet haben, und weitere Ressourcenlinks.

    Sie können alle Standardeinstellungen ändern, indem Sie auf Extras und Optionen klicken und dann die gewünschten Einstellungen vornehmen.

  2. Klicken Sie auf Datei, Neu und Projekt. Das Fenster Neues Projekt wird wie in Abbildung 2 angezeigt.

  3. Klicken Sie im Bereich Projekttypen auf Visual C#-Projekte und im Bereich Vorlagen auf Leeres Projekt.

  4. Geben Sie XML Comments in das Feld Name ein, und wählen Sie dann einen Speicherort für Ihr Projekt aus (in dieser Übung wird der standardmäßige Speicherort verwendet). Anmerkung Für den Namen dieses Projekts steht zwischen "XML" und "Comments" ein Leerzeichen.

  5. Klicken Sie auf OK.

    expvs3

    Abbildung 2. Fenster "Neues Projekt"

 

Erstellen der Quelldatei "XMLComment.cs"

Die Datei XMLComment.cs ist die Quelldatei, mit der das XML-Dokument erstellt wird. Kommentare zu XML-Tags und XML-bezogenem Text werden im C#-Code kommentiert, und aus diesen Tags und diesem Text wird beim Kompilieren der Quelldatei ein XML-Dokument erstellt.

Anmerkung Das XML-Kommentarzeichen ist in der C#-Sprache neu. Wenn ein Text mit drei Schrägstrichen (///) beginnt, ist dies für den Compiler das Zeichen, dass der folgende Text ein XML-Kommentar ist. Jede Zeile, die XML-Kommentar sein soll, muss mit drei Schrägstrichen beginnen. Die Kommentare müssen mit XML-Tags formatiert werden, damit aus den Kommentaren ein XML-Dokument erstellt werden kann.

  1. Klicken Sie auf Datei und Neues Element hinzufügen. Das Fenster Neues Element hinzufügen wird wie in Abbildung 3 angezeigt.

  2. Klicken Sie im Bereich Kategorien auf Lokale Projektelemente und im Bereich Vorlagen auf Codedatei.

  3. Geben Sie XMLComments.cs in das Feld Name ein.

Anmerkung Für den Namen dieses Projekts steht zwischen "XML" und "Comments" kein Leerzeichen.

expvs4

Abbildung 3. Fenster "Neues Element hinzufügen"

  1. Klicken Sie auf Öffnen.

  2. Geben Sie auf der Seite den folgenden Code ein:

    using System; 
class XmlElement 
{ 
   /// <summary> 
   ///    Gibt das Attribut mit dem angegebenem Namen und 
   ///    Namespace zurück</summary> 
   /// <param name="name"> 
   ///    Der Name des Attributs</param> 
   /// <param name="ns"> 
   ///    Namespace des Attributs oder Null, wenn 
   ///    das Attribut keinen Namespace hat</param> 
   /// <return> 
   ///    Attributwert oder Null, wenn das Attribut 
   ///    nicht vorhanden ist</return> 
   /// <seealso cref="GetAttr(string,string)"/> 
   public string GetAttr(string name, string ns) { 
      return "test"; 
   } 
}

  3. Klicken Sie auf Datei und XMLComments.cs speichern (oder klicken Sie auf das Symbol Speichern). Die Datei wird im Projektordner gespeichert.

  4. Klicken Sie auf Datei und Beenden. Wenn das Fenster Microsoft Entwicklungsumgebung angezeigt wird, klicken Sie auf Ja, um die Änderungen in Ihrem Projekt zu speichern.

 

Öffnen des Projekts und der Quelldatei in der IDE

  1. Klicken Sie auf Start, Programme, Microsoft Visual Studio .NET und Microsoft Visual Studio .NET.

  2. Klicken Sie auf Datei, Öffnen und Projekt.

  3. Erweitern Sie C:\Dokumente und Einstellungen\Administrator\Eigene Dateien\Visual Studio-Projekte\XMLComments.

  4. Klicken Sie auf XMLComments.csproj oder XMLComments.sln und dann auf Öffnen. Anmerkung Wenn Sie auf eine dieser Dateien klicken, wird das Projekt geöffnet.

    Wenn die Quelldatei nicht im Hauptfenster geöffnet wird, doppelklicken Sie im Projektmappen-Explorer auf das Symbol XMLComments.cs wie in Abbildung 4 dargestellt. Die Quelldatei wird im Hauptfenster geöffnet. Lassen Sie die IDE geöffnet, um die folgenden Schritte auszuführen.

    expvs5

    Abbildung 4. IDE-Ansicht des Dokuments "XMLComments.cs"Anmerkung

    Der Systemnamespace wird am Dateianfang deklariert. Alle Klassen in diesem Namespace sind für die XmlElement-Klasse verfügbar.

    Die XML-Elemente mit dem Namen "param" verfügen über Attribute mit den Namen name und ns. Diese Attributwerte werden im C#-Code GetAttr()-Methode unter den Kommentaren übergeben.

 

Kompilieren von Codebeispielen

In diesem Abschnitt verwenden Sie zwei bereits vorhandene Dateien, make.bat und doc.xsl. Diese Dateien müssen in den Projektordner XMLComments kopiert werden, damit die Codebeispiele korrekt kompiliert werden.

Anmerkung Die Datei doc.xsl liefert die Stylesheetvorlage für die Anzeige der Datei doc.xml in einem Webbrowser, die Datei make.bat enthält C#-Compileroptionen.

  1. Klicken Sie auf Start, Programme, Zubehör und Windows-Explorer.

  2. Erweitern Sie C:\FieldContent\Experience VS.NET\Lab2.

  3. Markieren Sie die Dateien doc.xsl und make.bat, klicken Sie auf Bearbeiten und Kopieren.

  4. Erweitern Sie C:\Dokumente und Einstellungen\Administrator\Eigene Dateien\Visual Studio-Projekte\XMLComments.

  5. Klicken Sie auf Bearbeiten und Einfügen, um die Dateien in den Ordner XMLComments einzufügen.
    Kompilieren Sie das Codebeispiel mit der MS-DOS-Eingabeaufforderung.

  6. Erweitern Sie in Windows-Explorer den Ordner C:\FieldContent\Experience VS.NET\Lab2.

  7. Doppelklicken Sie auf Eingabeaufforderung.

  8. Geben Sie type make.bat ein, und drücken Sie die EINGABETASTE. Dadurch wird der Inhalt der Datei make.bat auf dem Bildschirm angezeigt. Anmerkung Die Datei make.bat enthält die folgenden Parameter:

    Den csc-Befehl für den Aufruf des C#-Compilers.

    Die /target-Option, die das Format der Ausgabedatei angibt, in diesem Fall handelt es sich um eine Bibliotheksdatei oder DLL (XMLComment.dll).

    Die /doc-Option weist den Compiler an, aus den Dokumentationskommentaren in der Quelldatei eine XML-Datei (doc.xml) zu erstellen.

    XMLComment.cs ist die vom Compiler verwendete Quelldatei.

  9. Geben Sie make ein, und drücken Sie die EINGABETASTE. Das Fenster Eingabeaufforderung wird wie in Abbildung 5 angezeigt.

Anmerkung Die Erstellung der Dateien doc.xml und XMLComment.dll erfolgt nach Verwendung des Erstellungsbefehls. Sie werden automatisch erstellt und im Projektordner XMLComments gespeichert. Dies ist in C# die Standardeinstellung. Sie müssen keinen neuen Pfad angeben, sofern Sie den Pfad nicht ändern möchten.

ex6

Abbildung 5. Das Fenster "Eingabeaufforderung" nach Erstellung der Datei "doc.xml"

  1. Schließen Sie das Fenster Eingabeaufforderung.

 

Anwenden der XSL-Vorlage auf die XML-Datei

Sie wenden nun die XSL-Vorlage auf die erstellte XML-Datei (doc.xml) an. Sie öffnen die XML- und XSL-Dateien in der IDE und wenden dann die XSL-Vorlage an, damit das XML-Dokument korrekt in einem Webbrowser angezeigt werden kann.

  1. Klicken Sie in der IDE auf Datei und Vorhandenes Element hinzufügen.

  2. Erweitern Sie C:\Dokumente und Einstellungen\Administrator\Eigene Dateien\Visual Studio-Projekte\XMLComments.

  3. Klicken Sie auf doc.xml und Öffnen. Die Datei doc.xml wird wie in Abbildung 6 in der IDE geöffnet.

    exvps6

    Abbildung 6. "Doc.xml" in der IDE

    Sie öffnen nun die Rohversion von doc.xml im Webbrowser.

  4. Klicken Sie auf Ansicht und Öffnen mit.

  5. Klicken Sie auf Iexplore.exe und Öffnen. Die Rohversion der Datei doc.xml wird wie in Abbildung 7 in Microsoft Internet Explorer geöffnet. Anmerkung In Internet Explorer werden nicht formatierte XML-Dateien als eine Abfolge von Tags mit reduzierbaren "-"-Zeichen angezeigt.

    expvs78

    Abbildung 7. "Doc.xml" in Internet Explorer vor Anwenden des Stylesheets

  6. Schließen Sie Internet Explorer, indem Sie auf Datei und Schließen klicken.

  7. Öffnen Sie die Vorlage doc.xsl, indem Sie in der IDE auf Datei und Vorhandenes Element hinzufügen klicken.

  8. Erweitern Sie C:\Dokumente und Einstellungen\Administrator\Eigene Dateien\Visual Studio-Projekte\XMLComments.

  9. Wählen Sie im Feld Dateityp die Option Alle Dateien. Sie können dann auf die Datei doc.xsl zugreifen.

  10. Klicken Sie auf doc.xsl und Öffnen. Die Vorlage doc.xsl wird wie in Abbildung 8 in der IDE geöffnet.

    expsss2

    Abbildung 8. "Doc.xsl" in der IDEAnmerkung

    Die Datei doc.xsl enthält eine kommentierte Verarbeitungsanweisung in der zweiten Zeile,

    <?xml:stylesheet href="doc.xsl" type="text/xsl"?>.

    Diese Zeile wird im nächsten Schritt der XML-Datei hinzugefügt.

  11. Wenn Sie die Vorlage doc.xsl auf die Datei doc.xml anwenden möchten, markieren Sie die XML-Verarbeitungsanweisung aus der zweiten Zeile der Vorlage doc.xsl, wie in Abbildung 9 dargestellt, und klicken Sie auf Bearbeiten und Kopieren.

    exp1

    Abbildung 9. Stylesheet-Verarbeitungsanweisung in "doc.xsl"

  12. Klicken Sie auf die Registerkarte doc.xml.

  13. Fügen Sie zwischen der Deklaration

    <?xml version="1.0"?>

    und dem Tag

    <doc>

    eine Leerzeile ein.

  14. Setzen Sie den Cursor in die Leerzeile, klicken Sie auf Bearbeiten und Einfügen. Daraufhin wird auf dem Bildschirm Folgendes angezeigt:

    exp8

    Abbildung 10. "Doc.xml" mit Stylesheet-Verarbeitungsanweisung

  15. Klicken Sie auf Datei und doc.xml speichern.

  16. Wenn Sie das Dokument gespeichert haben, wird der Doppelpunkt aus der Verarbeitungsanweisung

    <?xml:stylesheet…?>

gelöscht. Setzen Sie einen Gedankenstrich (-) zwischen die Begriffe "xml" und "stylesheet" (ohne die Klammern, wie in der zweiten Zeile in Abbildung 11), damit die Verarbeitungsanweisung ordnungsgemäß funktioniert. Wenn Sie den Gedankenstrich eingefügt haben, klicken Sie auf Datei und doc.xml speichern.

exp8

Abbildung 11. "Doc.xml" mit korrekter Stylesheetformatierung

 

Öffnen der endgültigen Version von "Doc.xml"

Sie können doc.xml nun mit angewendetem Stylesheet in einem Browser anzeigen. Stellen Sie sicher, dass in der IDE die Registerkarte doc.xml ausgewählt wurde.

  1. Klicken Sie auf Ansicht und Öffnen mit.

  2. Klicken Sie auf Iexplore.exe und Öffnen. Die Datei doc.xml wird im Browser mit der Formatierung aus doc.xsl wie in Abbildung 12 angezeigt.

    expvs

    Abbildung 12. "Doc.xml" in Internet Explorer mit angewendetem Stylesheet

 

Abschließen von Übung 2

  1. Klicken Sie auf Datei und Schließen, um Internet Explorer zu schließen.

  2. Klicken Sie auf Datei und Beenden, um die IDE zu schließen.