繁体   English   中英

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

[英]How to tag code in C# 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>

但这总是创造一个新的段落......

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

<c>标签听起来像是你正在寻找的东西。 有关更多详细信息,请查看MSDN的标记参考

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

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM