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

Статья
11/05/2008

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

<summary>description</summary>

Параметры

description
Сводка объекта.

Заметки

Тег <summary> следует использовать для описания типа или члена типа. Чтобы добавить дополнительную информацию в описание типа, используйте <remarks>.

Текст в теге <summary> является единственным источником сведений о типе для технологии IntelliSense и также отображается в Обозреватель объектов.

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

Пример

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

    /// text for Main
    static void Main()
    {
    }
}

См. также

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

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

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