Compartilhar via

<see> (Guia de programação C#)

  • Artigo
<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 existe emember passa para o nome de elemento no XML.Membro de localidade dentro de aspas duplas (” ").

Comentários

A marca de <see> permite que você especifique um link de dentro do texto.Use <seealso> para indicar que o texto deve ser colocado considerar também seção.Use o atributo cref para criar hiperlinks internos páginas de documentação para elementos de código.

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

O exemplo a seguir mostra uma marca de <see> em uma seção de resumo.

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

    /// text for Main
    static void Main()
    {
    }
}

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

Consulte também

Referência

Marcas recomendadas para comentários da documentação (C# Guia de programação)

Conceitos

Guia de programação do C#