Dokumentationskommentare

23/10/2007 - 10:49 von Christian Schlyia | Report spam
Hallo NG

Ich Informiere mich gerade über die Dokumentationskommentare und habe
folgendes Beispiel aus der MSDN ausprobiert:

''' <remarks>Before calling the <c>Reset</c> method, be sure to:
''' <list type="bullet">
''' <item><description>Close all connections.</description></item>
''' <item><description>Save the object state.</description></item>
''' </list>
''' </remarks>
Public Sub Reset()
' Code goes here.
End Sub

Laut Beschreibung soll dann im Objektbrowser in den Hinweisen eine
Auflistung erscheinen, jedoch wird der Text einfach nur hintereinander
angezeigt.

Falls eine Liste nicht möglich ist wàren zumindest Zeilenumbrüche
ausreichend.

Vielen Dank schon mal für eure Hilfe.

Gruß Chris
 

Lesen sie die antworten

#1 Herfried K. Wagner [MVP]
23/10/2007 - 18:19 | Warnen spam
"Christian Schlyia" schrieb:
Ich Informiere mich gerade über die Dokumentationskommentare und habe
folgendes Beispiel aus der MSDN ausprobiert:

''' <remarks>Before calling the <c>Reset</c> method, be sure to:
''' <list type="bullet">
''' <item><description>Close all connections.</description></item>
''' <item><description>Save the object state.</description></item>
''' </list>
''' </remarks>
Public Sub Reset()
' Code goes here.
End Sub

Laut Beschreibung soll dann im Objektbrowser in den Hinweisen eine
Auflistung erscheinen, jedoch wird der Text einfach nur hintereinander
angezeigt.



Ich nehme eher an, diese Formatierungen werden nur bei XML/HTML-Ausgabe
berücksichtigt, aber nicht im Objektbrowser angezeigt.

Falls eine Liste nicht möglich ist wàren zumindest Zeilenumbrüche
ausreichend.



Versuche '<par>Text</par>' für einen Absatz und '<br/>' für einen
Zeilenumbruch.

M S Herfried K. Wagner
M V P <URL:http://dotnet.mvps.org/>
V B <URL:http://dotnet.mvps.org/dotnet/faqs/>

Ähnliche fragen