Etiqueta de documentación <seealso>

La etiqueta <seealso> le permite especificar el texto que quiere que aparezca en una sección Vea también. Use <see> para especificar un vínculo desde dentro del texto.

Sintaxis

/// <seealso cref="member"/>

Parámetros

member
Referencia a un miembro o campo al cual se puede llamar desde el entorno de compilación actual. Ponga el nombre entre comillas simples o dobles.

El compilador comprueba si el elemento de código dado existe y resuelve member en el nombre de elemento en el resultado XML. El compilador emite una advertencia si no encuentra member.

Para información sobre cómo crear una referencia cref a un tipo genérico, consulte <see>.

Comentarios

Compile con /doc para procesar los comentarios de documentación a un archivo.

Vea <summary> para obtener un ejemplo en el que se usa <seealso>.

El compilador de MSVC intentará resolver las referencias cref en un solo paso mediante los comentarios de documentación. Si el compilador no encuentra un símbolo al usar las reglas de búsqueda de C++, marca la referencia como no resuelta.

Ejemplo

En el siguiente ejemplo, se hace referencia a un símbolo sin resolver en cref. El comentario XML de la cref a A::Test tiene el formato correcto: <seealso cref="M:A.Test" />. Sin embargo, el crefB::Test se convierte en <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() {}
};

Consulte también

Documentación de XML