<see> (Guía de programación de C#)

<see cref="member"/>

Parámetros

• cref = "member"
  Referencia a un miembro o campo al cual se puede llamar desde el entorno de compilación actual.El compilador comprueba si el elemento de código dado existe y pasa member al nombre de elemento en el resultado XML.Agregue member entre comillas dobles (" ").

Comentarios

La etiqueta <see> permite especificar un vínculo desde dentro del texto.Utilice <seealso> para indicar que el texto debe colocarse en una sección Vea también.Use el atributo cref para crear hipervínculos internos a las páginas de documentación de los elementos de código.

Compile con el parámetro /doc para procesar los comentarios de documentación y generar un archivo con ellos.

El ejemplo siguiente muestra una etiqueta de <see> dentro de una sección resumen.

// 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()
    {
    }
}

Vea <summary> para obtener un ejemplo de cómo usar <see>.

Vea también

Referencia

Etiquetas recomendadas para comentarios de documentación (Guía de programación de C#)

Conceptos

Guía de programación de C#