vb@rchiv · Tipps & Tricks · Eigene Property Beschreibung in der Intellisense II

Rubrik: Entwicklungsumgebung · VB-IDE allgemein | VB-Versionen: VB.NET

27.09.07

Eigene Property Beschreibung in der Intellisense II Erweiterung der eigenen Property Beschreibung in der Intellisense Ansicht (VB.Net 2005)
Autor: Carsten Stuplich	Bewertung:	Views: 12.230
ohne Homepage	System: WinNT, Win2k, WinXP, Win7, Win8, Win10, Win11	kein Beispielprojekt

Bereits in einem früheren Tipp wurde gezeigt, wie man eigene Propertys, Funktionen und Prozeduren auf einfache Weise mit der Intellisense-Funktionalität ausstattetn kann:
Eigene Property Beschreibung in der Intellisense

Heute zeigen wir, wie sich die XML-Struktur dahingehend erweitern lässt, dass auch Code-Beispiele mit aufgenommen werden können. Das ist besonders dann hilfreich, wenn man eine Klasse erstellt hat und z.B. mit "Sandcastle" eine Hilfedatei im CHM-Format erstellen möchte.

Hierfür muss man unterhalb der remarks folgende Struktur anhängen:

''' <example> 
''' <code>
''' </code>
''' </example>

Um zu kennzeichnen um welche .NET-Sprache es sich bei dem Beispiel handelt, muss man dies im öffnenten Code-Tag noch über das Attribut "lang" bestimmen:

(Beispiel für VB.NET):

''' <example> 
''' <code lang="VB">
''' </code>
''' </example>

Hier ein komplettes Beisspiel um eine einfache Funktion mit einem VB-Code-Beispiel zu versehen:

''' <summary> 
''' Gibt einen übergebenen Text als String zurück. 
''' </summary> 
''' <param name="Text">Text der durch die Funktion zurückgegeben wird</param> 
''' <returns></returns> 
''' <remarks></remarks> 
''' <example> 
''' <code lang="VB">
''' 
''' messagebox.show(HalloWelt("Hallo Welt!")) 
''' 
''' </code>
''' </example> 
Function HalloWelt(ByVal Text As String) As String
  Return Text
End Function

Anmerkung:
Man kann gleichzeitig ein VB und C# Code-Beispiele einfügen. In diesem Fall hängt man vorm einfach noch ein:

''' <code lang="C#">
''' </code>

an.