<typeparam> (Руководство по программированию на C#)
<typeparam name="name">description</typeparam>
Параметры
name
Имя параметра типа.Заключите имя в двойные кавычки (" ").description
Описание параметра типа.
Заметки
Тег <typeparam> должен использоваться в комментарии объявления универсального типа или метода для описания параметра типа.Добавьте тег для каждого параметра типа для универсального типа или метода.
Дополнительные сведения см. в разделе Универсальные шаблоны (Руководство по программированию на C#).
Текст для тега <typeparam> будет отображен в IntelliSense, веб-отчете комментариев кода Object Browser Window.
Чтобы обработать и сохранить комментарии документации в файл, при компиляции необходимо использовать параметр /doc.
Пример
// compile with: /doc:DocFileName.xml
/// comment for class
public class TestClass
{
/// <summary>
/// Creates a new array of arbitrary type <typeparamref name="T"/>
/// </summary>
/// <typeparam name="T">The element type of the array</typeparam>
public static T[] mkArray<T>(int n)
{
return new T[n];
}
}
См. также
Ссылки
Рекомендуемые теги для комментариев документации (Руководство по программированию на C#)
Основные понятия
Руководство по программированию на C#