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

时间:2011-02-23 15:37:56

标签: c# xml documentation xml-documentation

我有这个功能:

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 个答案:

答案 0 :(得分:8)

&lt; c&gt;标签听起来像是你正在寻找的东西。有关详细信息,请查看MSDN的tag reference

那就是说,您确定要文档直接引用该功能执行的操作吗?如果您决定稍后更改实施,该怎么办?我知道这是一个非常简单的例子,但值得深思! :)