Compartilhar via


<see>(Guia de programação translation from VPE for Csharp)

<see cref="member"/>

Parâmetros

  • cref = "member"
    Uma referência a um membro ou campo que está disponível para ser chamado a partir do ambiente de compilação atual.O compilador verifica se o elemento de código fornecido existe e passa member ao nome do elemento na saída XML. Coloque membro entre aspas duplas ("").

Comentários

O <see>marca permite que você especificar um link de dentro do texto.Use <seealso> para indicar que o texto deve ser colocado em uma seção Consulte também.

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

See <resumo> para obter um exemplo de uso <see>.

Exemplo

O exemplo a seguir mostra como fazer um cref referência a um tipo genérico.

// compile with: /doc:DocFileName.xml 

// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <summary cref="C{T}">
/// </summary>
class A { }

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

// the following cref shows how to hard-code the reference
/// <summary cref="T:C`1">
/// </summary>
class B { }

/// <summary cref="A">
/// </summary>
/// <typeparam name="T"></typeparam>
class C<T> { }

Consulte também

Conceitos

Guia de Programação C#

Referência

Recomendado Rótulos de comentários de documentação (guia de programação translation from VPE for Csharp)