<see> značka dokumentace

Značka <see> umožňuje zadat odkaz z textu. Slouží <seealso> k označení textu, který se může zobrazit v oddílu Viz.

Syntaxe

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

Parametry

member
Odkaz na člena nebo na pole, které lze volat z prostředí aktuální kompilace. Uzavřete název do jednoduchých nebo dvojitých uvozovek.

Kompilátor zkontroluje, zda daný element kódu existuje a překládá member na název elementu ve výstupním XML. Kompilátor vydá upozornění, pokud ho nenajde member.

Poznámky

Zkompilujte je /doc pro zpracování komentářů dokumentace k souboru.

Příklad použití <see>, viz <summary>.

Kompilátor MSVC se pokusí vyřešit cref odkazy v jednom průchodu komentáři dokumentace. Pokud kompilátor nenajde symbol při použití vyhledávacích pravidel jazyka C++, označí odkaz jako nevyřešený. Další informace najdete na webu <seealso>.

Příklad

Následující ukázka ukazuje, jak můžete odkazovat cref na obecný typ, aby kompilátor přeložil 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 < 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 {};

Viz také

Dokumentace XML