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


<see> (Visual C++)

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

<see cref="member"/>

Параметры

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

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

Заметки

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

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

Компилятор C Visual C++ пытается разрешить ссылки cref в одном прохождении через документирующие комментарии.Поэтому при использовании правила поиска C, C++, символ не найден компилятором, ссылка будет помечена как не разрешен.Дополнительные сведения см. в разделе <seealso> (Visual C++).

Пример

В следующем примере показано, как можно сделать ссылку на универсальному типу, то 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 &lt; T &gt;"/>

// 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 (Visual C++)