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

Статья
11/05/2008

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

<see cref="member"/>

Параметры

cref = " member"
Ссылка на член или поле, которые могут вызываться из текущей среды компиляции. Компилятор проверяет, существует ли данный элемент кода и передает ли он member имени элемента в выходных XML-данных.Поместите член в двойные кавычки (" ").

Заметки

Тег <see> позволяет определить ссылку в тексте. Используйте тег <seealso> для обозначения текста, который надо поместить в раздел See Also (см. также).

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

Пример использования тега <see> см. в разделе <summary>.

Пример

В следующем примере показано, как создать ссылку cref на универсальный тип.

// compile with: /doc:DocFileName.xml 

// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <summary cref="C{T}">
/// </summary>
class A { }

// the following cref shows another way to specify the reference, 
// such that, the compiler will resolve the reference
// <summary cref="C &lt; T &gt;">

// the following cref shows how to hard-code the reference
/// <summary cref="T:C`1">
/// </summary>
class B { }

/// <summary cref="A">
/// </summary>
/// <typeparam name="T"></typeparam>
class C<T> { }

См. также

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

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

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