c# - 将注释放入我的 C# XML 注释块中存在的 XML 中

Question

我在 XML 注释中使用代码示例块作为一种简单的方法让用户了解 XML 的外观。这是一个非常粗略的解决方案，最终将为用户提供 xml 字符串的 XML Schema。但是，现在我将只在基于 doxygen 的文档中提供这些信息。

例如，我有这样的事情：

/// <example>
/// <code>
///   <!-- xml will go below this comment, but I can't display the comment! -->
/// </code>
/// </example>

当我查看我的文档时，任何有注释的行都会显示为空行。

我试过用<and转义>，也试过用<CDATA[<!-- comment -->]]>, 没有成功。转义序列按原样显示，并按CDATA原样显示，但未显示字符数据。

我在这里错过了什么？:)

编辑——我需要澄清这不是 Intellisense 呈现信息的问题。我希望 XML 注释在由 Doxygen 呈现到 CHM 时正确显示（通过 HTML Help Workshop）。

Answer 1

当您尝试使用 and 进行转义时<，>您是否使用了这种语法？

/// <example>
/// <code>
///   &lt;!-- xml will go below this comment, but I can't display the comment! --&gt;
/// </code>
/// </example>

它在 IntelliSense 中工作，我看不出有任何理由为什么它不应该在其他地方工作。

编辑：你能试试下面的版本吗？

/// <example>
/// <pre lang='xml'> 
///   &lt;!-- xml will go below this comment, but I can't display the comment! --&gt;
/// </pre> 
/// </example>

Answer 2

我不确定您的 XML 源出现在哪里，是在函数或类的文档中吗？如果是这样，请尝试将 XML 包装在verbatim和\endverbatim标记中。对于以下示例

/** A test class with some XML in the documentation.

 \verbatim
 <example>
 <code>
   <!-- xml will go below this comment, but I can't display the comment! -->
 </code>
 </example>
 \endverbatim
*/
class Test
    ...

我得到了 doxygen 输出：