Beispiel für die XML-Dokumentation
Aktualisiert: November 2007
In diesem Beispiel wird gezeigt, wie Code mithilfe von XML dokumentiert wird. Weitere Informationen finden Sie unter XML-Dokumentationskommentare (C#-Programmierhandbuch).
So erhalten Sie Beispiele und Anweisungen zu ihrer Installation
Führen Sie eine oder mehrere der folgenden Aktionen aus:
Klicken Sie im Menü Hilfe auf Samplings.
In der Infodatei befinden sich Informationen zu Beispielen.
Gehen Sie zur Website mit Visual Studio 2008-Beispielen. Hier stehen die aktuellsten Versionen der Beispiele bereit.
Suchen Sie Beispiele auf dem Computer, auf dem Visual Studio installiert wurde. Standardmäßig werden Beispiele und eine Infodatei unter Laufwerk:\Programme\Microsoft Visual Studio 9.0\Beispiele\lcid installiert. Für die Express-Version von Visual Studio werden alle Beispiele online bereitgestellt.
Weitere Informationen finden Sie unter Suchen von Beispieldateien.
.gif "Sicherheitshinweis") Sicherheitshinweis: |
|---|
Dieser Beispielcode soll lediglich ein Konzept veranschaulichen. Es wird nur der für das jeweilige Konzept relevante Code dargestellt. Möglicherweise erfüllt dieser nicht die Sicherheitsanforderungen für eine bestimmte Umgebung, und er sollte nicht genau wie dargestellt verwendet werden. Wir empfehlen, Sicherheits- und Fehlerbehandlungscode hinzuzufügen, um Ihre Projekte sicherer und stabiler zu machen. Microsoft stellt diesen Beispielcode "wie besehen" und ohne Garantien zur Verfügung. |
So erstellen Sie das Beispiel für die XML-Dokumentation in Visual Studio
Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf das Projekt, und klicken Sie dann auf Eigenschaften.
Öffnen Sie den Ordner für die Konfigurationseigenschaften, und klicken Sie auf Erstellen.
Legen Sie für die Eigenschaft XML-Dokumentationsdatei die Datei XMLsample.xml fest.
Klicken Sie im Menü Erstellen auf Erstellen.
Die XML-Ausgabedatei wird im Debugverzeichnis gespeichert.
So erstellen Sie das Beispiel für die XML-Dokumentation über eine Eingabeaufforderung
Geben Sie Folgendes an der Eingabeaufforderung ein, um die XML-Beispieldokumentation zu erzeugen:
csc XMLsample.cs /doc:XMLsample.xmlGeben Sie zum Anzeigen der erstellten XML-Datei folgenden Befehl ein:
type XMLsample.xml
Siehe auch
Aufgaben
Gewusst wie: Verwenden der XML-Dokumentationsfeatures (C#-Programmierhandbuch)