如何在XML注释中添加List类型代码示例?

时间:2016-01-21 03:50:51

标签: c# xml-documentation

我使用了以下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;
    }

但它有以下警告错误,

  

关于&#39; SampleCollection&#39;的XML评论格式错误的XML - &#39;结束标记   &#39;代码&#39;与开始标记&#39;字符串&#39;不匹配。&#39;

因为列表定义具有<string>。因此它将其视为XML标记。

有什么方法可以解决这个问题吗?

1 个答案:

答案 0 :(得分:5)

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

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