Hinzufügen Dokumentation zu Ihrem Visual Basic NET (VB.NET )-Projekt ist wichtig, damit Menschen mit Ihrem Programm einen Platz, um weitere Informationen über Funktionen, die sie Probleme mit zu finden haben . . Visual Studio verwendet '' ' , eine Dokumentation Linie, die erstellt es automatisch eine XML-Vorlage für zu bedeuten. Wenn Sie Ihr Projekt kompilieren , wird Visual Studio eine XML-Datei aus Ihren Unterlagen Kommentare erstellen. Things You
Microsoft Visual Studio 2005, 2008 oder 2010
brauchen anzeigen Weitere Anweisungen
1
Öffnen Sie Ihre VB.NET-Projekt in Microsoft Visual Studio 2005, 2008 oder 2010 .
2
Suchen Sie den Code für einen Typ oder Member , die Sie dokumentieren und platzieren Sie den Cursor auf die Zeile über dem Code . Eine Art gehören Dinge wie eine Schnittstelle oder Klasse. Zu den Mitgliedern gehören Dinge wie eine Subroutine , Funktion, Ereignis -oder Sachschäden.
3
hinzufügen '' '(3 einfache Anführungszeichen Zeichen) an den Anfang der Zeile. Dies legt eine Dokumentation Linie . Der Code-Editor fügt ein XML- Skelett für die Elemente auf der Linie darunter.
4
Fügen Sie Ihre Dokumentation als Text zwischen den XML-Tags . Es ist möglich, neue XML- Dokumentations -Tags , indem Sie den " VBXMLDOC.xml "-Datei mit einem Text-Editor hinzufügen. Die Datei wird in Visual Studio " Application Data " oder " AppData " -Ordner.
5
Fügen Sie zusätzliche Zeilen Code mit den XML-Dokumentation Kommentare , die den Typ oder Member verwenden . Ein tag zeigt zusätzliche Informationen über den Typ oder Member .
6 Klicken Sie auf Ihr Projekt auf dem Explorer . Klicken Sie auf das Menü "Projekt" und klicken Sie auf "Eigenschaften". Klicken Sie auf das Register "Übersetzen" und fügen Sie " /doc " in der " Generate XML-Dokumentation -Datei " ein. Dies veranlasst den Compiler, eine XML-Datei zu erstellen, wenn Sie das Projekt kompilieren .
7
Erstellen einer XML- Dokumentation -Datei durch die Zusammenstellung Ihrer VB.NET-Projekt . Die Datei wird im selben Ordner wie die . Exe oder . Dll -Datei erscheinen.
