So fügen Sie einen Zeilenumbruch in die C # .NET-Dokumentation ein

196

Dies sollte einfacher sein ...

Ich möchte der XML-Dokumentation in meinem Code einen "codierten" Zeilenumbruch hinzufügen

/// <summary>
/// Get a human-readable variant of the SQL WHERE statement of the search element. &lt;br/&gt;
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>

Wie Sie sehen können, habe ich einige Antworten gefunden, die das Hinzufügen von <und> Klammern demonstrierten. Interessanterweise führt der gute alte Zeilenumbruch nicht zu einem Zeilenumbruch im Intellisense-Popup.

Ich finde das nervig ...

Irgendwelche Vorschläge?

c# .net xml-documentation Tinkerer_CardTracker
quelle
3
Ab Visual Studio 2019 können Sie <br/> zum Erstellen von Zeilenumbrüchen verwenden. Lesen Sie die Antwort hier .
23bl

Antworten:

314

Sie können ein <para />Tag verwenden, um einen Absatzumbruch zu erzeugen, oder Sie können Text in <para></para>Tags einschließen, um den Text zu gruppieren und die leere Zeile danach hinzuzufügen, aber es gibt kein Äquivalent dazu <br />oder ähnliches. (Was laut diesem alten MS-Forumsbeitrag beabsichtigt ist.) Die Liste der verfügbaren Tags in diesem Dokumentationsartikel erhalten Sie von MS. Dokumentieren Sie Ihren Code

Beispiel (basierend auf dem Original-OP-Beispiel): 

/// <summary>
/// <para>Get a human-readable variant of the SQL WHERE statement of the search element.</para>
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>
pstrjds
quelle
5
Aha! Jetzt wurde gekocht! Vielen Dank! Das hat mich schon lange gestört ... Ich habe die Para-Option aufgelistet gesehen, aber angenommen, dass es sich um eine "Parameter" -Kürzel handelt.
Tinkerer_CardTracker
2
Hat bei mir nicht funktioniert. Bei Verwendung von VB.NET unter VS 2010, das mit und ohne die kolorierten Parameteroption von Powertools versucht wurde, werden <para>Tags ignoriert und in Intellisense wird alles in einer einzigen Zeile gemischt. Diese Frage wurde gefunden, in der Hans das Problem erklärte: stackoverflow.com/questions/7070737/… .
Neolisk
1
Stellen
85
Das Schlimme daran ist, dass tatsächlich eine ganze Leerzeile anstelle einer neuen Zeile hinzugefügt wird.
Devid
6
Hat jemand einen Weg gefunden, eine Zeile anstelle von zwei einzufügen?
75

Dies ist meine Verwendung, wie <br/>, es funktioniert :)

/// <summary>
/// Value: 0/1/2
/// <para/>0 foo,
/// <para/>1 bar,
/// <para/>2 other
/// </summary>
IlPADlI
quelle
8
Warum wird diese Antwort abgelehnt? Es funktioniert, und scheint eine viel bessere Lösung als die Verwendung von zu sein <para>&#160;</para>, <para>&nbsp;</para>oder die unsichtbaren Zeichen ...
Dinei
Dies funktioniert für Zeilenumbrüche, fügt jedoch keine Leerzeile zwischen den Dingen ein, wie dies bei den anderen Optionen der Fall ist.
Yushatak
15
In neueren Versionen von VS <para/>scheint eine leere Zeile hinzugefügt zu werden, nicht nur ein Zeilenumbruch.
Dinei
2
@IlPADlI, +1 als Verwendungsbeispiel. Bestätigte Arbeit an VS 2012 Ultimate Update 5.
Dennis T - Reinstate Monica -
9
VS 2017: leere Zeile hinzugefügt, nicht nur Zeilenumbruch ... Microsoft liebt es, uns zu sagen, was wir tun wollen ...
Assimilater
39

Ab Visual Studio 2019 <br/>für Zeilenumbrüche in Kommentaren verwenden.

Beispiel:

/// <summary>
/// This is a comment.<br/>
/// This is another comment <br/>
/// This is a long comment so i want it to continue <br/> on another line.
/// </summary>

Geben Sie hier die Bildbeschreibung ein

Beachten Sie, dass keine zusätzliche Zeile hinzugefügt wird, wenn wir <br/>stattdessen verwenden <para>.

23bl
quelle
4
Immer noch nützlich, da diese Frage das beste Google-Ergebnis für das Hinzufügen eines Zeilenumbruchs in der C # -Dokumentation ist.
Dan
27

Fügen Sie ein <para>Tag mit einem speziellen Zeichen hinzu, dem Zeichen 255 oder einem unsichtbaren Zeichen .

/// <summary>
/// Some text
/// <para>   </para>
/// More text
/// </summary>
/// <param name="str">Some string</param>
public void SomeMethod(string str) { }

Es wird so funktionieren:

Geben Sie hier die Bildbeschreibung ein

Joel
quelle
8
Dies ist hilfreich, &nbsp;funktioniert jedoch nicht, stattdessen verwenden/// <para>&#160;</para>
Robert H
1
Ich persönlich halte /// <para> </para>in einer Haftnotiz. Dann ist es einfach kopieren und einfügen! (Und es funktioniert - zumindest für mich)
Joel
2
Ich weiß nicht warum, aber Copy Paste /// <para> </para>funktioniert überhaupt nicht. /// <para>&#160;</para>funktioniert!
Wenqiang
8
Anstatt das <para>Tag zwischen Textblöcken zu verwenden, sollten Sie das <para>Tag um alle Absätze außer dem ersten im <summary>Element verwenden. Für die <typeparam>, <param>, <value>, <exception>, und <returns>Elemente, verwenden sie um alle Absätze , wenn Sie mehr als ein (optional , wenn Sie nur eine für diese Elemente haben). <note>Verwenden Sie für alle anderen Blockelemente (einschließlich innerhalb eines anderen Blockelements) <para>Tags um alle Absätze, auch wenn Sie nur eines haben.
Sam Harwell
1
Quelle: Ich habe dies verfasst, einschließlich des größten Teils
Sam Harwell
3

<br></br>und <br />scheinen nicht zu funktionieren, und manchmal geht es nicht wirklich darum, die <para>Sätze zu trennen, sondern um den Wunsch, eine leere Zeile für die Trennung von Bedenken zu haben. Ich erwähne dies hier, weil diese Frage vielen geschlossenen Fragen dieser Art zuzuschreiben scheint.

Das einzige, was ich zur Arbeit fand, war 

<para>&#160;</para>

Beispielsweise

/// <summary>
///     <para>
///         "This sentence shows up when the type is hovered"
///     </para>
///     <para>&#160;</para>
///     <para>int PrimaryKey</para>
///     <para>&#160;</para>
///     <para>virtual Relation Relation</para>
/// </summary>

Ergebnisse in

"This sentence shows up when the type is hovered"

int PrimaryKey

virtual Relation Relation
Travis J.
quelle