如何在 C# 摘要中包含 html 标记，以便将其作为文本处理（不解析为 XML）？

Posted 2023-02-15

【中文标题】如何在 C# 摘要中包含 html 标记，以便将其作为文本处理（不解析为 XML）？

【英文标题】：How do I include an html tag in a C# summary so that it is processed as text (not parsed as XML)?

【发布时间】：2010-11-08 03:46:23

【问题描述】：

我正在用 C# 编写一个 html 解析器，并希望在摘要 XML 块中包含它处理的 HTML 示例。如何防止 字符弄乱 Visual Studio 2008 的自动文档？

示例：

  /// <summary>
  /// Creates a FlowSegment based on an HTML code, i.e. <bold>
  /// </summary>
  /// <param name="code"></param>
  /// <returns></returns>
  public FlowSegment(string code)
  

不幸的是，该示例导致此构造函数的工具提示（部分）显示：

XML comment includes invalid XML

而不是摘要注释。

如何转义 字符？

【参考方案1】：

我找到的最佳解决方案是更改它以便将 < 和 > 替换为 >

在XML specifications 中找到。

这使得示例如下所示：

  /// <summary>
  /// Creates a FlowSegment based on an HTML code, i.e. &lt;bold&gt;
  /// </summary>
  /// <param name="code"></param>
  /// <returns></returns>
  public FlowSegment(string code)
  

这使得所需的工具提示正确显示。