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

【问题标题】：How to tag code in C# XML documentation如何在 C# XML 文档中标记代码
【发布时间】：2011-02-23 15:37:56
【问题描述】：

我有这个功能：

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()) 将被格式化为纯文本，这使得它几乎不可读。所以我尝试了

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

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

这是我的问题：
有没有办法格式化一段文本，使它看起来好像是代码？我会对固定宽度的字体感到满意。

【问题讨论】：

【解决方案1】：

标签听起来就是你要找的东西。查看 MSDN 的 tag reference 了解更多详情。

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

【讨论】：