Marca de documentação <see>

A marca <see> permite especificar um link de dentro do texto. Use <seealso> para indicar o texto que você deseja exibir em uma seção Confira também.

Sintaxe

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

Comentários

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

Para um exemplo de como usar <see>, confira <summary>.

O compilador do MSVC tentará 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. Para obter mais informações, consulte <seealso>.

Exemplo

O exemplo a seguir explica como você pode fazer uma referência cref a um tipo genérico, de modo que o compilador resolva 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 < T >"/>

// 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 {};

Confira também

Documentação XML