NewLine in der Objektzusammenfassung

97

Schöne Grüße

Wenn Sie eine Zusammenfassung für eine Eigenschaft / ein Feld / eine Methode usw. festlegen, ist es möglich, eine neue Zeile darin zu haben?

/// <summary>
/// This is line 1
/// This is line 2
/// </summary>
public bool TestLine { get; set; }

Wenn ich dies einstelle, wird wie bei der Maus angezeigt:

bool TestLine
This is line 1 This is line 2

Aber ich möchte, dass es Folgendes zeigt:

bool TestLine
This is line 1 
This is line 2

Ich habe es versucht, \naber das funktioniert nicht. Gibt es eine Möglichkeit, dies zu erreichen?

Theun Arbeider
quelle

Antworten:

185

Sie möchten so etwas verwenden

/// <summary> 
/// Your Main comment 
/// <para>This is line 1</para> 
/// <para>This is line 2</para> 
/// </summary> 
public bool TestLine { get; set; }
Noch ein anderer Benutzer
quelle
1
@YetAnotherUser, was ist mit einer Leerzeile?
Behzad
1
@Behzad versuchen mit <para>&nbsp;</para>.
Noch ein anderer Benutzer
15
Ich hasse diese zusätzlichen Zeilen :(
Jan Macháček
10
In der Visual Studio 2017-IDE zeigt die obige "Lösung" tatsächlich eine einzelne leere Zeile zwischen Zeile 1 und Zeile 2 an (dh eine neue Zeile nach Zeile 1, gefolgt von einer leeren Zeile, dann Zeile 2) - dies ist nicht dasselbe a neue Leitung, wie vom OP angefordert. Ist das ein Fehler in der VS 2017-IDE - oder sieht jeder, der hochgestimmt hat, nicht, dass diese Antwort nicht das ergibt, was das OP als gewünschte Ausgabe anzeigt?
Jazimov
Das ist ein neuer Absatz, keine neue Zeile. Ich habe das Gefühl, dass die Dokumentationssyntax etwas einschränkend ist.
GrizzlyMcBear
33

Ja:

/// <summary> 
/// Main comment 
/// <para>Line 1</para> 
/// <para>Line 2</para> 
/// </summary> 
public bool TestLine { get; set; }
Mitch Wheat
quelle
10

Dies mag ein alter Thread sein, aber ich habe bei der Verwendung von Visual Studio 2019 nach einer Antwort gesucht . Ich wollte Absatz- und Zeilenumbrüche. Folgendes funktioniert gut für mich:

/// <summary>
/// <para>parameter name="guidType" options:</para>
/// <br>0 = SequentialAsString</br>
/// <br>1 = SequentialAsBinary</br>
/// <br>2 = SequentialAtEnd</br>
/// </summary>

Produziert folgendes:

parameter name="guidType" options:

0 = SequentialAsString
1 = SequentialAsBinary
2 = SequentialAtEnd
Thomas Cayne
quelle
4
Für VS2019 und höher ist diese Antwort technisch korrekter als die akzeptierte Antwort.
Riaan Walters
Sie können <br /> auch nur am Ende der Zeile in VS2019 verwenden. Diese Lösungen erzeugen einen tatsächlichen Zeilenumbruch und keinen neuen Absatz mit einer leeren Zeile! Vielen Dank
Phillip S
5

Sie können <para />eine neue Zeile in die Zusammenfassung einfügen:

/// <summary> 
/// Main comment<para />
/// Line 1<para />
/// Line 2<para />
/// </summary>
public bool TestLine { get; set; }

Sieht aus wie:

Main comment
Line 1
Line 2

Freundliche Grüße!

fdelgado
quelle
2

Ich füge dies nur für jeden hinzu, der Xamarin Studio so verwendet wie ich. Ich habe festgestellt, dass keine der oben genannten Lösungen für mich funktioniert, aber diese hat Folgendes getan:

/// <summary>
/// Main summarry line.
/// <para></para>
/// <para></para>
/// Your secondary summary
/// </summary>

Dies ergibt die folgende Ausgabe:

Summary  
Main summary line.

Your secondary summary
Kopf in den Codes
quelle
1

Wenn Sie Swashbuckle (Swagger Web API-Integrationsbibliothek) verwenden, <para></para>sollte dies durch ersetzt werden <p></p>und <br/>könnte auch verwendet werden.

also das folgende

    /// <para>
    ///     Flag1, Flag2
    ///     - bool flags, optional.
    /// </para>

wird

    /// <p>
    ///     Flag1, Flag2<br/>
    ///     - bool flags, optional.
    /// </p>

Das Problem ist hier bereits beschrieben: Wie füge ich der Swashbuckle-Dokumentation einen Zeilenumbruch hinzu? - Verwenden einer speziellen Konfiguration, des Kommentars von domaindrivendev, https://github.com/domaindrivendev/Swashbuckle/issues/258 - zur <br/>Verwendung.

Dmitry Karpenko
quelle
0

Sie können legitimerweise Para-Tags hinzufügen, dies erstellt jedoch tatsächlich einen neuen Absatz für jede neue Zeile und der Zeilenabstand wird deaktiviert.
Ich persönlich füge 1 Absatz um den Absatz hinzu und brtagge dann am Ende der Zeilen, für die ich eine Unterbrechung wollte, wodurch ein anständiger Zeilenabstand erhalten bleibt:

/// <summary> 
/// <para>Main comment<br /> 
/// Line 1<br />
/// Line 2</para> 
/// </summary>
public bool TestLine { get; set; }
PDizzle
quelle
3
Dies funktioniert nicht und der Abstand zu <para> ist nicht schlecht. Welche Version von VS / .Net verwenden Sie?
Dani
2
HTML-Tags werden von ignoriert summary, auch wenn sie sich im paraTag befinden.
Lazaro Fernandes Lima Suleiman
-7

Ich würde empfehlen, diese Formatierung zu verwenden, wenn Sie mehrere Zeilen in der Zusammenfassung haben möchten, ohne dies zu komplizieren. Es funktioniert, wenn Sie nach jeder Zeile das <br /> -Tag verwenden. (Wenn Sie es irgendwo im Text verwenden, wird eine neue Zeile erstellt, in der sich auch das Tag befindet.)

Beachten Sie jedoch, dass Sie in der nächsten Zeile ein zusätzliches Leerzeichen erhalten, wenn Sie nach dem <br /> -Tag ein Leerzeichen haben. Sie möchten also in jeder Zeile den gleichen Platz haben, sodass jede Zeile in einer geraden Linie verläuft.

/// <summary>
/// This is line 1<br />
/// This is line 2<br />
/// This is line 3<br />
/// </summary>
public bool TestLine { get; set; }
Jonathan
quelle
3
Das erste, was ich versucht habe, bevor ich nach einer Lösung gesucht habe, weil das nicht funktioniert!
Philippe
Für mich geht das!
CWKSC
Funktioniert auch bei mir. Upvoted
AlexWei