Compartilhar via


<see> (Visual C++)

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

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

Comentários

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

Consulte <summary> para um exemplo de como usar <see>.

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.Consulte <seealso> (Visual C++) para maiores informações.

Exemplo

O exemplo a seguir mostra como você pode fazer a referência de cref a um tipo genérico, de forma que, o compilador resolverá a referência.

// xml_see_cref_example.cpp
// compile with: /LD /clr /doc
// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <see cref="C{T}">
/// </see>
ref class A {};

// the following cref shows another way to specify the reference, 
// such that, the compiler will resolve the reference
/// <see cref="C &lt; T &gt;"/>

// the following cref shows how to hard-code the reference
/// <see cref="T:C`1">
/// </see>
ref class B {};
 
/// <see cref="A">
/// </see>
/// <typeparam name="T"></typeparam>
generic<class T>
ref class C {};

Consulte também

Outros recursos

XML Documentation (Visual C++)