Beispiel für XML-Kommentare

Aktualisiert: November 2007

In diesem Beispiel wird das XML-Kommentarfeature von Visual Basic veranschaulicht.

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.

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 führen Sie dieses Beispiel aus

• Drücken Sie F5.

Veranschaulicht

In diesem Beispiel wird veranschaulicht, wie XML-Kommentare erstellt werden, wie sie im Editor angezeigt werden und wie programmgesteuert auf sie zugegriffen werden kann.

Die Automobile-Klasse definiert die folgenden Typelemente, die jeweils einen anderen Aspekt der XML-Kommentare veranschaulichen:

• TypenAutomobile und EngineOption

• Eigenschaften   Model

• Methoden   Konstruktoren, Upgrade, CalculateMaxTowing, WillItTow

• Ereignisse   NeedsTuneUp

• Delegaten   RotateTires, ReplaceSparkPlugs

• Felder   car, modelValue

Der Click-Ereignishandler für die Schaltfläche Create Car ruft mehrere Automobile-Member auf. Wenn Sie IntelliSense im Code-Editor verwenden, werden die XML-Kommentare als QuickInfos angezeigt.

Der Click-Ereignishandler für die Schaltfläche List Summaries verwendet für die Abfrage der XML-Datei, die die XML-Kommentare enthält, die XmlDocument-Klasse. Wenn das Projekt kompiliert wird, wird diese XML-Datei erstellt und mit der Projektassembly gespeichert. Auf der Registerkarte Kompilieren des Projekt-Designers können Sie den Speicherort und den Namen dieser Datei angeben.

Siehe auch

Aufgaben

Gewusst wie: Erstellen einer XML-Dokumentation in Visual Basic