Wie man einen Zeilenumbruch in der C # .NET Dokumentation hinzufügt

Diese sollte viiiiel einfacher...

Möchte ich hinzufügen, dass eine "codierte" Zeilenumbruch", um die XML-Dokumentation in meinem code

///<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, ich fand einige Antworten zeigen, hinzufügen < und > Klammern.
Interessant ist, das gute 'ol < br/> Zeilenumbruch nicht zu einem Zeilenumbruch in der Intellisense-popup.

Finde ich das ärgerlich...

Irgendwelche Vorschläge?

InformationsquelleAutor der Frage Tinkerer_CardTracker | 2011-09-02

  1. 238

    Hinzufügen <para />. Dadurch erhalten Sie einen Absatz zu brechen.

    Bearbeiten

    Sie können den Zeilenumbruch in <para></para> tags als eine Möglichkeit, um der Gruppe den text und fügen Sie die leere Zeile, nach der es, aber es gibt kein äquivalent zu <br /> oder etwas ähnliches. (Die nach diese alte MS-forum ist von design.) Sie können die Liste der verfügbaren tags, die in dieser Dokumentation Artikel von FRAU Dokumentieren Sie Ihren code

    Beispiel (basierend auf der ursprünglichen 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>

    InformationsquelleAutor der Antwort pstrjds

  2. 47

    Dies ist mein Sprachgebrauch, wie <br/> Ihre Arbeit 🙂

    ///<summary>
///Value: 0/1/2
///<para/>0 foo,
///<para/>1 bar,
///<para/>2 other
///</summary>

    InformationsquelleAutor der Antwort IlPADlI

  3. 21

    Hinzufügen <para> tag mit einem speziellen char, 255 char, oder unsichtbare char. 

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

    Wird es arbeiten wie diese:

    Wie man einen Zeilenumbruch in der C # .NET Dokumentation hinzufügt

    InformationsquelleAutor der Antwort Joel

  4. 2

    <br></br> und <br /> scheinen nicht zu arbeiten, und manchmal ist es nicht wirklich darum, die <para> Sätze trennen, so viel wie der Wunsch, haben Sie eine leere Zeile zur Sorge Trennung. Ich erwähne dies hier, weil diese Frage scheint zu sein, die Eltern zu viele geschlossene Fragen dieser Natur.

    Das einzige was ich gefunden habe zu arbeiten, 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

    InformationsquelleAutor der Antwort Travis J

Schreibe einen Kommentar