Ошибка документации на C# xml

Question

Я пытаюсь добавить документацию к своему C# -коду. Но следующее дает мне неправильную ошибку xml. Я знаю, что ошибка вызвана «отображением списка». Он пытается найти «/ Display». Но не будет «/ Display», потому что это часть моего кода. Может кто-то помочь мне с этим? Спасибо.

/// <summary> 
    /// Retrieves a list of <c>Display</c> 
    /// </summary> 
    /// <example> 
    /// <code> 
    ///  List<Display> templates = DisplayManager.GetDisplays(); 
    /// </code> 
    /// </example> 

Answer 1

Оберните свой код в CDATA блоке:

/// <code> 
///  <![CDATA[ 
///  List<Display> templates = DisplayManager.GetDisplays(); 
///  ]]> 
/// </code> 

или закодировать угловые скобки:

/// <code> 
///  List&lt;Display&gt; templates = DisplayManager.GetDisplays(); 
/// </code> 

Answer 2

Попробуйте обертывание содержание Yout кода в CDATA

<![CDATA[List<Display> templates = DisplayManager.GetDisplays();]]> 

Весь текст в XML-документе будет анализироваться синтаксическим анализатором.

Но текст внутри секции CDATA будет игнорироваться синтаксическим анализатором.

Answer 3

Это довольно часто писать List{Display} в документации XML.