c# - 如何在XML注释中添加List类型的代码示例？

Question

我在下面使用了 XML 注释，

    /// <example> 
    /// This example shows how to use <see cref="SampleCollection"/> property.
    /// <code>
    /// class TestClass 
    /// {
    ///      List<string> collection = new List<string>();
    ///      collection.Add("Column1");
    ///      collection.Add("Column2");
    ///      this.SampleCollection = collection;
    /// }
    /// </code>
    /// </example>        
    public List<string> SampleCollection
    {
        get;
        set;
    }

但它有如下警告错误，

XML comment on 'SampleCollection' has badly formed XML -- 'End tag 'code' does not match the start tag 'string'.'

因为 List 定义有 <string> .所以它将其视为 XML 标记。

有什么办法可以解决吗？

Answer 1

使用 CDATA block在 XML 中嵌入原始文本:

<![CDATA[
List<string> ...
]]>