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

<param name="name">description</param>

Параметры

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

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

Заметки

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

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

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

Пример

// compile with: /doc:DocFileName.xml 

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

    // Multiple parameters.
    /// <param name="Int1">Used to indicate status.</param>
    /// <param name="Float1">Used to specify context.</param>
    public static void DoWork(int Int1, float Float1)
    {
    }

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

См. также

Ссылки

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

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

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