Sdílet prostřednictvím


<seealso> (Visual C++)

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

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

    Informace o vytváření cref odkaz na obecný typ naleznete v tématu <see> (Visual C++).

Poznámky

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

Viz <summary> (Visual C++) pro příklad použití <seealso>.

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ý.

Příklad

V následující ukázce nevyřešené symbol odkazuje cref.Komentář XML pro cref na B::Test <seealso cref="!:B::Test" />, že odkaz na A::Test je ve správném formátu <seealso cref="M:A.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é

Další zdroje

XML dokumentace (Visual C++)