C#摘要注释中的Xml字符串

C#摘要注释中的Xml字符串,c#,documentation,C#,Documentation,我正在记录我用C语言编写的一些方法,这些方法处理解析标记。由于系统其他领域的一些技术限制,这些令牌需要采用XML元素的形式(即)。我想把这些标记的格式放在摘要语句中 但是,这会引发一个错误:格式错误的XML——名称以无效字符开头”。是否有任何类型的转义字符序列可用于将XML嵌入我的C#摘要注释中?使用标准XML转义。例如: 这将获取令牌1并将其转换为令牌2 作为代码键入或读取并不十分容易,但IntelliSense正确地取消了这一点,您可以在工具提示中看到正确、可读的内容。使用CDATA部分。

我正在记录我用C语言编写的一些方法,这些方法处理解析标记。由于系统其他领域的一些技术限制,这些令牌需要采用XML元素的形式(即
)。我想把这些标记的格式放在摘要语句中


但是,这会引发一个错误:格式错误的XML——名称以无效字符开头”。是否有任何类型的转义字符序列可用于将XML嵌入我的C#摘要注释中?

使用标准XML转义。例如:

这将获取令牌1并将其转换为令牌2

作为代码键入或读取并不十分容易,但IntelliSense正确地取消了这一点,您可以在工具提示中看到正确、可读的内容。

使用CDATA部分。例如:

Bob]>
这在源代码中比在实体引用中编码特殊字符(当您有一个更大的XML片段时)更优雅和可读


如果要嵌入的XML包含CDATA节,则需要使用中或中所述的多个CDATA节。或者您也可以始终使用其他答案中所述的普通实体引用。

我使用转义序列,因为VisualStudios工具提示不显示CDATA节中的任何内容。

已经很晚了,但是遇到了同样的问题,使用
将在Intellisense中隐藏注释

同时替换
对我来说是一项艰巨的工作(lazy:)。我发现仅仅用code/code替换
result success=“True”>entity type=“resource”operation=“update”/>/result>
/// 
/// ]]>
/// 
/// 
Intellisense将显示以下内容:

Parse the queue process response
<?xml version="1.0" encoding="utf-16"?><result success="True"><entity type="resource" operation="update" /></result>
解析队列进程响应
但请参见。另请参见。中的更多详细信息。可能重复的
Parse the queue process response
<?xml version="1.0" encoding="utf-16"?><result success="True"><entity type="resource" operation="update" /></result>