vb@rchiv
VB Classic
VB.NET
ADO.NET
VBA
C#
SEPA-Dateien erstellen inkl. IBAN-, BLZ-/Kontonummernprüfung  
 vb@rchiv Quick-Search: Suche startenErweiterte Suche starten   RSS-Feeds  | Newsletter  | Impressum  | Datenschutz  | vb@rchiv CD Vol.6  | Shop Copyright ©2000-2019
 
zurück
Rubrik: Entwicklungsumgebung · VB-IDE allgemein   |   VB-Versionen: VB.NET24.04.06
Eigene Property Beschreibung in der Intellisense

Eigene Property Beschreibung in der Intellisense Ansicht (VB.Net 2005)

Autor:   Roland WutzkeBewertung:     [ Jetzt bewerten ]Views:  17.233 
www.vb-power.netSystem:  WinNT, Win2k, WinXP, Vista, Win7, Win8, Win10kein 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
 

Dieser Tipp wurde bereits 17.233 mal aufgerufen.

Voriger Tipp   |   Zufälliger Tipp   |   Nächster Tipp

Über diesen Tipp im Forum diskutieren
Haben Sie Fragen oder Anregungen zu diesem Tipp, können Sie gerne mit anderen darüber in unserem Forum diskutieren.

Aktuelle Diskussion anzeigen (1 Beitrag)

nach obenzurück


Anzeige

Kauftipp Unser Dauerbrenner!Diesen und auch alle anderen Tipps & Tricks finden Sie auch auf unserer aktuellen vb@rchiv  Vol.6

Ein absolutes Muss - Geballtes Wissen aus mehr als 8 Jahren vb@rchiv!
- nahezu alle Tipps & Tricks und Workshops mit Beispielprojekten
- Symbol-Galerie mit mehr als 3.200 Icons im modernen Look
Weitere Infos - 4 Entwickler-Vollversionen (u.a. sevFTP für .NET), Online-Update-Funktion u.v.m.
 
   

Druckansicht Druckansicht Copyright ©2000-2019 vb@rchiv Dieter Otter
Alle Rechte vorbehalten.
Microsoft, Windows und Visual Basic sind entweder eingetragene Marken oder Marken der Microsoft Corporation in den USA und/oder anderen Ländern. Weitere auf dieser Homepage aufgeführten Produkt- und Firmennamen können geschützte Marken ihrer jeweiligen Inhaber sein.

Diese Seiten wurden optimiert für eine Bildschirmauflösung von mind. 1280x1024 Pixel