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

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

  • Статья

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

<param name='name'>description</param>

Параметры

  • name
    Имя параметра метода. Заключите имя в двойные кавычки (" ").

  • description
    Описание для параметра.

Заметки

Тег <param> должен использоваться в комментариях объявления метода для описания его параметров.

Текст для тега <param> будет отображен в IntelliSense, в обозревателе объектов и в веб-отчете комментариев кода.

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

Пример

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <param name="Int1">Used to indicate status.</param>
    public static void DoWork(int Int1)
    {
    }
    /// text for Main
    static void Main()
    {
    }
}

См. также

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

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

Ссылки

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