c# - C# 摘要注释中的 XML 字符串

标签 c# documentation

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

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

最佳答案

使用标准的 XML 转义。例如:

<summary>This takes a &lt;token1&gt; and turns it into a &lt;token2&gt;</summary>

作为代码输入或阅读并不是特别容易,但 IntelliSense 正确地对其进行了转义,您会在工具提示中看到正确的、可读的内容。

关于c# - C# 摘要注释中的 XML 字符串,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/607094/

相关文章:

c# - EntityFramework 不创建表

c# - 如何在 View 中设置通用模型?

documentation - VSCode是否有 Electron 文档?

javascript - 如何记录返回特定值的函数?

c# - 两个单独的 UserControls 似乎是同一个实例

c# - XAML 重用标记 block

c# - Web Api 的 CreateResponse<Content>() 和 CreateResponse() 之间有什么区别吗?

swift - 如何找到给定类型可用的所有属性和方法?

python - opencv python 文档

protected 类的 Javadoc 方法