Sdílet prostřednictvím


<see> (Visual C++)

<see> tag umožňuje zadat odkaz v textu.Použití <seealso> označíte text, který chcete zobrazit v části Viz také.

<see cref="member"/>

Parametry

  • member
    Odkaz na člena nebo pole, které je možné volat z aktuálního prostředí kompilace.Název uzavřete do jednoduchých nebo dvojitých uvozovek.

    Kompilátor zjistí, že daný kód prvek existuje a řeší member na název prvku ve výstupu XML.Kompilátor vydá upozornění, pokud se nenajde member.

Poznámky

Kompilace s /doc k procesu dokumentační komentáře do souboru.

Viz <summary> pro příklad použití <see>.

Kompilátor Visual C++ se pokusí přeložit cref odkazy v jednom průchodu přes dokumentační komentáře.Proto, používáte-li vyhledávací pravidla C++, symbol nebyl nalezen pomocí kompilátoru odkaz bude označen jako nevyřešený.Další informace naleznete v tématu <seealso> (Visual C++).

Příklad

Následující příklad ukazuje, jak provést cref odkaz na obecný typ tak, aby kompilátor vyřeší odkaz.

// 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 {};

Viz také

Další zdroje

XML dokumentace (Visual C++)