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

How to tag code in C# XML documentation

提问人:sbi 提问时间:2/23/2011 更新时间:2/24/2011 访问量:1171

问:

我有这个功能:

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

我想记录下来。
我希望标签说,因为对于任何能够阅读 C# 代码的人来说,这都说了一千个字。但是,当我使用
<return>string.Join(separator, strings.ToArray())

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

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

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

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

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

C# XML xml-文档

评论


答:

8赞 Jeremy Todd 2/24/2011 #1

<c> 标签听起来像是你要找的。有关详细信息,请查看 MSDN 的标记参考

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