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: 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: ''' <code lang="C#"> ''' </code> an. Dieser Tipp wurde bereits 12.233 mal aufgerufen. Voriger Tipp | Zufälliger Tipp | Nächster Tipp
Anzeige
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. |
Neu! sevPopUp 2.0 Dynamische Kontextmenüs! Erstellen Sie mit nur wenigen Zeilen Code Kontextmenüs dynamisch zur Laufzeit. Vordefinierte Styles (XP, Office, OfficeXP, Vista oder Windows 8) erleichtern die Anpassung an die eigenen Anwendung... Tipp des Monats April 2024 Skyfloy Chart von Microsoft und dazu noch gratis Tutorial für Microsoft Chart Controls für Microsoft .NET Framework 3.5 TOP Entwickler-Paket TOP-Preis!! Mit der Developer CD erhalten Sie insgesamt 24 Entwickler- komponenten und Windows-DLLs. Die Einzelkomponenten haben einen Gesamtwert von 1605.50 EUR... |
||||||||||||||||
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. |