Rubrik: Entwicklungsumgebung · VB-IDE allgemein | VB-Versionen: VB.NET | 24.04.06 |
Eigene Property Beschreibung in der Intellisense Eigene Property Beschreibung in der Intellisense Ansicht (VB.Net 2005) | ||
Autor: Roland Wutzke | Bewertung: | Views: 19.390 |
www.vb-power.net | System: WinNT, Win2k, WinXP, Win7, Win8, Win10, Win11 | kein Beispielprojekt |
Die Intellisense Anzeige zu Eigenschaften, Methoden und Objekt in VB.Net ist eine gelungene Sache, da sie neben der Deklaration auch noch zusätzlich eine Kurzbeschreibung im ToolTip anzeigt.
Erstellt man jedoch seine eigene Klasse, so wird uns zwar in der erzeugten Objektvariable der Klasse bspw. der Funktionsaufruf im ToolTip angezeigt, doch es fehlt eine Kurzbeschreibung.
Wie können wir nun eine solche Kurzbeschreibung für die Intellisense Anzeige erstellen? Das Forum meint dazu; Das geht nicht, oder man benötigt ein Zusatzmodul, oder oder oder...
Es geht auch anders, und zwar mit den VB.Net 2005 Bordmitteln
Die Lösung sind drei hintereinander gestellte Hochzeichen ''' (Remarks).
Wenn Sie in Ihrem Klassenmodul direkt oberhalb einer Funktions- oder Property Zeile die drei Hochzeichen eingeben, erstellt VB.Net automatisch eine XML-Struktur, die wie folgt aussieht:
''' <summary> ''' ''' </summary> ''' <value></value> ''' <returns></returns> ''' <remarks></remarks>
Alles was Sie jetzt im „summery“ Knoten eintragen, wird im Intellisense als Kurzbeschreibung angezeigt.
Aber es geht noch weiter! Bei einer Funktion mit Parameterübergabe, können zusätzlich noch Informationen zu den Parametern angegeben werden, die dann wiederum in der Intellisense angezeigt werden. Die „param name“ Knoten werden auch hier automatisch durch die IDE erzeugt. Sie müssen lediglich nur die Beschreibung dazu eingeben.
''' <summary> ''' Sendet eine eMail an die angegebene eMail Adresse via SMTP-Server ''' </summary> ''' <param name="Server">Die IP-Adresse oder DNS Name des Servers</param> ''' <param name="eMailAddress">Eine gültige eMail Adresse</param> ''' <returns>Liefert True oder False</returns> ''' <remarks> ''' Dieses Beispiel demonstriert den Einsatz eigener Property Beschreibungen. ''' </remarks> Public Function SendEMail(ByVal Server As String, ByVal eMailAddress As String) As Boolean ' Tu was... ' Tu noch mehr... End Function
Die gleiche Technik können Sie übrigens auch auf den Klassennamen anwenden:
''' <summary> ''' Diese Klasse beinhaltet Methoden und Eigenschaften zum Versenden einer eMail ''' </summary> Public Class clsMyMail
Das ist der ganze Trick - einfach drei Hochzeichen eingeben. Das Ergebnis kann dann so aussehen:
Hinweis:
Der gezeigte Tipp ist nur für VB.Net 2005 gültig. Von 2003 wird diese Vorgehensweise nicht unterstützt. Erstellt wurde der Tipp mit VS2005 Pro.
Viel Spaß...
Roland Wutzke