将注释放在我的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>

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

我尝试使用<和>进行转义，并尝试使用<CDATA[<!-- comment -->]]>，但没有成功。转义序列按原样显示，CDATA按原样显示，但不显示字符数据。

我在这里想念什么？ ：）

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

Answer 1

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

/// <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输出：