2016-01-21 3 views
4

Я использовал ниже XML комментарий,Как добавить пример кода типа списка в комментарии 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 комментарий на 'SampleCollection' имеет плохо сформирован XML - «Конечный тег 'код' делает не соответствует начальному тегу 'string'. '

потому что определение списка имеет <string>. Поэтому он считал это тегом XML.

Есть ли способ разрешить это?

+1

Возможный дубликат [? Как избежать символов в C# комментарии] (http://stackoverflow.com/questions/4377372/how- do-i-escape-characters-in-c-sharp-comments) – Michael

ответ

5

Используйте CDATA block вставлять необработанный текст в XML:

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

[Это может быть полезно.] (https://stackoverflow.com/a/4377408/1187982) –

+0

спасибо. Но все же у меня есть предупреждение. Ниже приведен мой модифицированный код: /// excludeColumns = новый Список (); ///]]]> , пожалуйста, дайте мне знать, если я пропустил что-нибудь? –