Gewusst wie: Generieren einer XML-Dokumentation für ein Projekt

  • Artikel

Die XML-Dokumentationsdatei generieren-Eigenschaft bestimmt, ob bei der Kompilierung eine XML-Datei generiert wird. Diese Eigenschaft wird auf der Seite Kompilieren (für Visual Basic) bzw. Erstellen (für Visual C#) des Projekt-Designers festgelegt. Wenn diese Option aktiviert ist, wird die XML-Dokumentation automatisch in einer XML-Datei ausgegeben, die denselben Namen wie das Projekt und die Erweiterung .xml trägt.

Weitere Informationen über XML-Dokumentation in Visual Basic-Projekten finden Sie unter Gewusst wie: Erstellen einer XML-Dokumentation in Visual Basic. Entsprechende Informationen für Visual C# finden Sie unter XML-Dokumentationskommentare (C#-Programmierhandbuch).

Tipp

In den meisten Fällen ist es nicht erforderlich, die XML-Dokumentation bei jeder Kompilierung des Projekts zu generieren. Sie können warten, bis die Anwendung fertig ist. Bei großen Projekten können Sie die Kompilierung beschleunigen, indem Sie diese Option deaktivieren.

So generieren Sie eine XML-Dokumentationsdatei für ein Visual Basic-Projekt

  1. Wählen Sie im Projektmappen-Explorer ein Projekt aus, und klicken Sie im Menü Projekt auf Eigenschaften.

  2. Klicken Sie auf die Registerkarte Kompilieren.

  3. Wählen Sie auf der Seite Kompilieren die Option XML-Dokumentationsdatei generieren aus. Standardmäßig wird die Datei unter dem angegebenen Ausgabepfad erstellt, z. B. "bin\Debug\Projektname.XML".

So generieren Sie eine XML-Dokumentationsdatei für ein Visual C#-Projekt

  1. Wählen Sie im Projektmappen-Explorer ein Projekt aus, und klicken Sie im Menü Projekt auf Eigenschaften.

  2. Klicken Sie auf die Registerkarte Erstellen.

  3. Wählen Sie auf der Seite Erstellen die Option XML-Dokumentationsdatei generieren aus. Standardmäßig wird die Datei unter dem angegebenen Ausgabepfad erstellt, z. B. "bin\Debug\Projektname.XML".

Siehe auch

Aufgaben

Gewusst wie: Erstellen einer XML-Dokumentation in Visual Basic

Referenz

XML-Dokumentationskommentare (C#-Programmierhandbuch)

Erweitert, C#, Text-Editor, Dialogfeld "Optionen"

Weitere Ressourcen

Verwalten von Kompilierungseigenschaften