Compartilhar via


<seealso> (Visual C++)

A marca de <seealso> permite que você especifique o texto que você pode querer aparecer em uma seção consulte também.Use <see> para especificar um link de dentro do texto.

<seealso cref="member"/>

Parâmetros

  • member
    Uma referência a um membro ou campo que está disponível para ser chamado a partir do ambiente de compilação atual.Envolva-o com aspas simples ou double - marcas.

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

    Para obter informações sobre como criar uma referência de cref a um tipo genérico, consulte <see> (Visual C++).

Comentários

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

Consulte <summary> (Visual C++) para um exemplo de como usar <seealso>.

O compilador do Visual C++ tentará resolver referências de cref em uma passagem com comentários de documentação.Portanto, se usando as regras de pesquisa de C++, um símbolo não for encontrado pelo compilador a referência não será marcada como resolvida.

Exemplo

No exemplo a seguir, um símbolo resolvido não é referenciado em um cref.O comentário XML para o cref a B::Test será <seealso cref="!:B::Test" />, enquanto a referência a A::Test é <seealso cref="M:A.Test" />bem formado.

// 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 também

Outros recursos

XML Documentation (Visual C++)