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

Question

我想在 -NET C# XML 文档中添加 XML 代码，我找到了这个帮助：但不起作用

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

Answer 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 目前不显示它。

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

How to set XML code in NET XML documentation comments

c#

documentation

summary