將注釋放在我的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輸出：