Kommentare XML nicht in IntelliSense Anzeige
-
20-09-2019 - |
Frage
Ich versuche, VB.NET XML-Kommentare zur Arbeit mit IntelliSense zu bekommen, und vielleicht ist es nicht die Art und Weise arbeiten, ich denke, es funktioniert.
''' <summary>
''' Gets or sets the Patient Code.
''' <list type="bullet">
''' <listheader><description>Validation:</description></listheader>
''' <item><description>Field Required</description></item>
''' <item><description>Field Max Length: 25</description></item>
''' </list>
''' </summary>
''' <value>The region reference key.</value>
Dies sollte, wenn Sie mit der Eingabe in Funktion sind, zeigt das „Get oder setzt die Patienten-Code“, dann darunter, sollte es eine Liste der Aufzählungselemente mit Anzeige „Validierung:“ als Überschrift
alt text http://www.codejames.com/errored.jpg
Vielleicht irre ich es tue, aber es scheint nicht richtig zu funktionieren.
Lösung
Sie tun dies nicht falsch, es ist nur einfach nicht unterstützt. Während die HTML-Markups in der Ausgabe von einigen Tools erscheinen mag, ist IntelliSense nicht einer von ihnen.
IntelliSense ist eine Textanzeige in Visual Studio 2008 und wir unterstützen nicht viele Anzeigen / die meisten der Markups, wie sie sollten in einem HTML-Stil angezeigt. Stattdessen neigen wir dazu, die Markup-Tags abzustreifen, die nicht unterstützt werden, und die daraus resultierende Text angezeigt werden soll.
Andere Tipps
Sie kann „fake“ es (ohne die Zahlen) durch den <description>
Inhalt mit dem <para>
Tag umgibt - das wird zumindest zeigen, bis in Intellisense schön Abstand, aber ohne die entsprechenden Listentrennzeichen (Kugel, Zahl)
<summary>
Gets or sets the Patient Code.
<list type="bullet">
<listheader><description>Validation:</description></listheader>
<item><description>Field Required</description></item>
<item><description>Field Max Length: 25</description></item>
</list>
</summary>
<value>The region reference key.</value>
Wenn Sie kümmern sich nicht alles, was viel über die erzeugten Ausgangs einfach Ihre Kugel in jeder Zeile hinzufügen:
<item><description><para>* Field Required</para></description></item>
Siehe auch <list>
XML Dokumentation
Update
Da dieses Posting, VS2012 11.0.60610.01 Update 3 scheint hinzugefügt zu haben Unterstützung Formatierung, so dass Sie nicht mehr benötigen, die <para>
interne Verpackung oder Ihre eigenen Kugeln.