Frage

Nach dieser Artikel , es möglich ist, zu mehrzeilige XML-Kommentare erhalten - stattdessen ///, Verwendung /** */ zu verwenden. Das ist meine Interpretation dessen, was mehrzeilige Kommentare sind, und was ich haben will geschehen:

/**
 * <summary>
 * this comment is on line 1 in the tooltip
 * this comment is on line 2 in the tooltip
 * </summary>
 */

Allerdings, wenn ich dieses Formular benutzen, der Tooltip, das erscheint, wenn ich schweben über meine Klassennamen in meinem Code ist einzeilig, das heißt, es sieht genauso aus, als ob ich meinen Kommentar wie folgt geschrieben:

/// <summary>
/// this comment is on line 1 in the tooltip
/// this comment is on line 2 in the tooltip
/// </summary>

Ist dieses Verhalten tatsächlich möglich noch in VS2008?

Bearbeiten

gabe wies darauf hin, dass ich falsch verstanden, was „mehrzeilige“ bedeutet habe, und ich brauchte tatsächlich Gebrauch <para> oder <br> meinen beabsichtigten Effekt. Ich ging weiter und gebrauchte <br> weil ich steuern möchten, wo die Zeilenumbrüche auftreten, d.

/// <summary>
/// this comment is on line 1 in the tooltip<br/>
/// this comment is on line 2 in the tooltip<br/>
/// </summary>

Als ich im Tooltip für diese Klasse aussehen in meinem Code, endet alles immer noch auf einer Linie ... WTH? Habe ich etwas falsch machen hier?

UPDATE

Ok, ging ich weiter und versuchte, den <para>-Tag in jeder Zeile, und das funktioniert. Nicht sicher, warum <br/> nicht.

/// <summary>
/// <para>this comment is on line 1 in the tooltip</para>
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>
War es hilfreich?

Lösung

Es klingt wie Sie über das, was „multi-line“ Mittel verwechselt werden. Ein einzeiliger Kommentar endet am Ende der Zeile des Quellcodes, und wenn Sie möchten, dass der Kommentar fortsetzen Sie ein „///“ auf der nächsten Zeile setzen müssen. Ein mehrzeilige Kommentar beginnt mit einem „/*“ und endet mit einem „*/“, so dass es entweder in der gleichen Zeile oder mehr Zeilen nach unten enden kann.

Das „Multi-line“ sagt nichts über jede, wie der Text innerhalb des Kommentars angezeigt. Um einen Zeilenumbruch in einem XML-Kommentar setzen Sie ein <br/> einfügen muss ( "break") oder wickeln Sie die Zeile in einem <para> ( "Absatz") Tag.

Andere Tipps

Versuchen Sie diese

/// <summary>
/// this comment is on line 1 in the tooltip
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>

In <br/> für Zeilenumbrüche oder die Absätze in <para>...</para> umschließen. Es ist wie XML und HTML, der Zeilenumbruch ist nichts anderes als Leerzeichen.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top