我有这个功能:
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>
但这总是会创建一个新段落...
所以这是我的问题:
有没有一种方法可以格式化一段文本,使其看起来像是代码?我会对固定宽度的字体感到满意。
最佳答案
标记听起来像是您要寻找的。查看MSDN的tag reference了解更多详细信息。
也就是说,您确定要文档直接引用该功能执行的操作吗?如果您决定稍后更改实现该怎么办?我知道这是一个非常简单的例子,但值得深思! :)