Frage Wie man Code in der C # XML Dokumentation kennzeichnet


Ich habe diese Funktion:

public static string Join(this IEnumerable<string> strings, string separator)
{
    return string.Join(separator, strings.ToArray());
}

was ich dokumentieren möchte.
Ich will das <return> Tag zu sagen string.Join(separator, strings.ToArray()) denn jeder, der C # -Code lesen kann, sagt mehr als tausend Worte. Wie auch immer, wenn ich benutze

<return>string.Join(separator, strings.ToArray())</return>

Dann wird string.Join (separator, strings.ToArray ()) als einfacher Text formatiert, was es fast unlesbar macht. Also habe ich es versucht

<return><code>string.Join(separator, strings.ToArray())</code></return>

aber das schafft immer einen neuen Absatz ...

Also hier ist meine Frage:
Gibt es eine Möglichkeit, einen Text so zu formatieren, dass er wie Code aussieht? Ich wäre mit einer Schriftart mit fester Breite zufrieden.


5
2018-02-23 15:37


Ursprung


Antworten:


Das <c> -Tag klingt, als ob es das ist, wonach Sie suchen. Sieh dir MSDN's an Tag Referenz für mehr Details.

Sind Sie sicher, dass die Dokumentation direkt auf die von der Funktion ausgeführten Aktionen verweisen soll? Was ist, wenn Sie sich entscheiden, die Implementierung später zu ändern? Ich weiß, das ist ein ziemlich triviales Beispiel, aber Denkanstoß! :)


8
2018-02-23 16:15