Marca de documentação <seealso>

A marca <seealso> permite especificar o texto que você quer que seja exibido na seção Consulte também. Use <see> para especificar um link de dentro do texto.

Sintaxe

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

Parâmetros

member
Uma referência a um membro ou campo disponível para ser chamado do ambiente de compilação atual. Coloque o nome entre aspas simples ou duplas.

O compilador verifica se o elemento de código fornecido existe e resolve member no nome de elemento no XML de saída. O compilador emite um aviso se não encontrar member.

Para obter informações sobre como criar uma referência cref para um tipo genérico, confira <see>.

Comentários

Compile com /doc para processar comentários de documentação em um arquivo.

Confira <summary> para ver um exemplo de como usar <seealso>.

O compilador do MSVC tenta resolver as referências cref em uma passagem pelos comentários da documentação. Se o compilador não encontrar um símbolo ao usar as regras de pesquisa do C++, ele marcará a referência como não resolvida.

Exemplo

No exemplo a seguir, um símbolo não resolvido é referenciado em um cref. O comentário XML para o cref do A::Test está bem formado: <seealso cref="M:A.Test" />. No entanto, o cref para o B::Test se torna <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() {}
};

Confira também

Documentação XML