<see> тег документации

Тег <see> позволяет задать ссылку из текста. Используйте <seealso> для указания текста, который может появиться в разделе "См. также ".

Синтаксис

/// <see cref="member"/>

Параметры

member
Ссылка на член или поле, которые доступны для вызова из текущей среды компиляции. Заключите имя в одинарные или двойные кавычки.

Компилятор проверяет, существует ли элемент кода, и разрешает member в имя элемента в выходных XML-данных. Компилятор выдает предупреждение, если он не находит member.

Замечания

Скомпилируйте их для /doc обработки примечаний документации к файлу.

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

Компилятор MSVC попытается разрешить cref ссылки в одном проходе через комментарии документации. Если компилятор не находит символ при использовании правил подстановки C++, он помечает ссылку как неразрешенную. Дополнительные сведения см. в разделе <seealso>.

Пример

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

// xml_see_cref_example.cpp
// compile with: /LD /clr /doc
// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <see cref="C{T}">
/// </see>
ref class A {};

// the following cref shows another way to specify the reference,
// such that, the compiler will resolve the reference
/// <see cref="C < T >"/>

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

/// <see cref="A">
/// </see>
/// <typeparam name="T"></typeparam>
generic<class T>
ref class C {};

См. также

XML-документация