vb@rchiv
VB Classic
VB.NET
ADO.NET
VBA
C#
TOP-Angebot: 17 bzw. 24 Entwickler-Vollversionen zum unschlagbaren Preis!  
 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.NET27.09.07
Eigene Property Beschreibung in der Intellisense II

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

Autor:   Carsten StuplichBewertung:     [ Jetzt bewerten ]Views:  10.603 
ohne HomepageSystem:  WinNT, Win2k, WinXP, Vista, Win7, Win8, Win10kein 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.

Dieser Tipp wurde bereits 10.603 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.

Neue Diskussion eröffnen

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