<typeparamref> (Руководство по программированию на C#)
<typeparamref name="name"/>
Параметры
- name
Имя параметра типа.Заключите имя в двойные кавычки (" ").
Заметки
Дополнительные сведения параметрах типа в универсальных типах и методах см. в разделе Универсальные шаблоны.
Использование этого тега позволит пользователям файла документации придать слову определенный формат, например выделить его курсивом.
Чтобы обработать и сохранить комментарии документации в файл, при компиляции необходимо использовать параметр /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#)