如何在C# XML文档中标记代码

Question

我有这个函数：

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

我希望记录下来的内容。
我希望<return>标签显示string.Join(separator, strings.ToArray())，因为对于会阅读C#代码的人来说，这样表述更加清晰易懂。然而，在使用时

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

然后使用 string.Join(separator, strings.ToArray()) 格式化的结果会被呈现为纯文本，这使得它几乎无法阅读。因此，我尝试了

在格式化之前将其包含在 HTML 标签中。

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

但是这总是创建一个新的段落...

所以我的问题是： 有没有一种方法可以格式化一段文本，使其看起来像代码？我会满足于等宽字体。

- sbi

Answer 1

<c> 标签听起来就像是你正在寻找的。查看 MSDN 的 标签参考 以获取更多详细信息。

话虽如此，你确定想要文档直接引用函数执行的操作吗？如果以后你决定更改实现呢？我知道这只是一个相当琐碎的例子，但也值得思考！ :)

- Jeremy Todd