c# - 如何在 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# 代码的人来说，这都超过了 1000 个单词。但是，当我使用

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

然后 string.Join(separator, strings.ToArray()) 将被格式化为纯文本，这使得它几乎不可读。所以我尝试了

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

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

所以这是我的问题:
有没有一种方法可以格式化一段文本，使其看起来就像是代码？我会对固定宽度的字体感到满意。

Answer 1

标签听起来像是您要查找的内容。查看 MSDN 的 tag reference了解更多详情。

也就是说，您确定要文档直接引用函数执行的操作吗？如果您决定稍后更改实现怎么办？我知道这是一个非常简单的例子，但值得深思! :)