Sdílet prostřednictvím

<seealso> značka dokumentace

  • Článek

Značka <seealso> umožňuje zadat text, který se může zobrazit v oddílu Viz také. Slouží <see> k zadání odkazu z textu.

Syntaxe

/// <seealso 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.

Informace o tom, jak vytvořit cref odkaz na obecný typ, naleznete v tématu <see>.

Poznámky

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

Podívejte se <summary> na příklad použití <seealso>.

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

Příklad

V následující ukázce se na nevyřešený symbol odkazuje v objektu cref. Komentář XML pro cref to A::Test je dobře formátován: <seealso cref="M:A.Test" />. Nicméně, to cref B::Test se stane <seealso cref="!:B::Test" />.

// xml_seealso_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_seealso_tag.dll

/// Text for class A.
public ref struct A {
   /// <summary><seealso cref="A::Test"/>
   /// <seealso cref="B::Test"/>
   /// </summary>
   void MyMethod(int Int1) {}

   /// text
   void Test() {}
};

/// Text for class B.
public ref struct B {
   void Test() {}
};

Viz také

Dokumentace XML