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 (" ").
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.
Compile con el parámetro /doc para procesar los comentarios de documentación y generar un archivo con ellos.
Vea <summary> para obtener un ejemplo del uso de <see>.
El ejemplo siguiente muestra cómo convertir una referencia cref en un 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 < T >">
// 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> { }
Referencia
Etiquetas recomendadas para comentarios de documentación (Guía de programación de C#)
Conceptos
Guía de programación de C#