如何在 NET XML 文档注释中设置 XML 代码

【问题标题】：How to set XML code in NET XML documentation comments如何在 NET XML 文档注释中设置 XML 代码
【发布时间】：2021-05-03 02:17:38
【问题描述】：

我想在 -NET C# XML 文档中添加 XML 代码，我找到了以下帮助：https://stackoverflow.com/a/11030588/2825284 但不起作用

        /// <summary>
        /// My comentary:
        /// <code>
        ///     <MyXmlCode>
        ///         <XmlNode Atribute="34"/>
        ///     </MyXmlCode>
        /// </code>
        /// </summary>

【问题讨论】：

标签： c# documentation summary

【解决方案1】：

您的示例代码包含需要转义的保留 XML 字符。这些字符及其转义序列是：

< ... &lt;
> ... &gt;
& ... &amp;

所以你的评论必须是：

        /// <summary>
        /// My comentary:
        /// <code>
        ///     &lt;MyXmlCode&gt;
        ///         &lt;XmlNode Atribute="34"/&gt;
        ///     &lt;/MyXmlCode&gt;
        /// </code>
        /// </summary>

或者，为了使其更具可读性，请使用 CDATA：

        /// <summary>
        /// My comentary:
        /// <code><![CDATA[
        ///     <MyXmlCode>
        ///         <XmlNode Atribute="34"/>
        ///     </MyXmlCode>
        /// ]]></code>
        /// </summary>

顺便说一句，我们的VSdocman 包含生成 CDATA 的评论编辑器。 CDATA 的一个缺点是 Intellisense 目前不显示它。

【讨论】：

谢谢@Peter Macej