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

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

  • Статья

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

<remarks>description</remarks>

Параметры

  • Description
    Описание члена.

Заметки

Тег <remarks> используется для добавления сведений о типе, дополняющих сведения, указанные в <summary>. Эти сведения отображаются в Обозреватель объектов.

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

Пример

// compile with: /doc:DocFileName.xml 

/// <summary>
/// You may have some primary information about this class.
/// </summary>
/// <remarks>
/// You may have some additional information about this class.
/// </remarks>
public class TestClass
{
    /// text for Main
    static void Main()
    {
    }
}

См. также

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

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

Ссылки

Рекомендуемые теги для комментариев документации (Руководство по программированию в C#)