How to tag code in C# XML documentation

Question

I have this function:

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

which I want to document.
I want the <return> tag to say string.Join(separator, strings.ToArray()) since to anyone able to read C# code this says more than a thousand words. However, when I use

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

then string.Join(separator, strings.ToArray()) will be formatted as plain text, which makes it almost unreadable. So I tried

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

but this always creates a new paragraph...

So here's my question:
Is there a way to format a piece of text so that it appears as if it were code? I'd be satisfied with a fixed-width font.

Jeremy Todd · Accepted Answer · 2011-02-23 16:25:16Z

8

The <c> tag sounds like it's what you're looking for. Check out MSDN's tag reference for more details.

That said, are you sure you want the documentation to refer directly to the actions performed by the function? What if you decide to change the implementation later? I know this is a pretty trivial example, but food for thought! :)

edited Feb 23, 2011 at 16:25

answered Feb 23, 2011 at 16:15

Jeremy Todd

3,2991 gold badge20 silver badges17 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to tag code in C# XML documentation

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related