<list> (Руководство по программированию на C#)

Статья
11/05/2008

Обновлен: Ноябрь 2007

<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>

Параметры

term
Термин, значение которого будет определено параметром description.
description
Элемент маркированного или нумерованного списка, определяющий значение параметра term.

Заметки

Блок <listheader> служит для задания строки заголовка таблицы или списка определений. При определении таблицы достаточно указать запись для term в заголовке.

Каждый элемент в списке указывается в блоке <item>. При создании списка определений необходимо указать и term, и description. Однако для таблицы, маркированного или нумерованного списка достаточно указать только description.

Список или таблица могут содержать столько блоков <item>, сколько необходимо.

Чтобы обработать комментарии к документации в файле, при компиляции необходимо использовать параметр /doc.

Пример

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>Here is an example of a bulleted list:
    /// <list type="bullet">
    /// <item>
    /// <description>Item 1.</description>
    /// </item>
    /// <item>
    /// <description>Item 2.</description>
    /// </item>
    /// </list>
    /// </summary>
    static void Main()
    {
    }
}

См. также

Основные понятия

Руководство по программированию в C#

Поделиться через