Etiqueta de documentación <see>
La etiqueta <see>
permite especificar un vínculo desde el texto. Use <seealso>
para indicar el texto que quiere que aparezca en una sección Vea también.
Sintaxis
/// <see cref="member"/>
Parámetros
member
Referencia a un miembro o campo al cual se puede llamar desde el entorno de compilación actual. Ponga el nombre entre comillas simples o dobles.
El compilador comprueba si el elemento de código dado existe y resuelve member
en el nombre de elemento en el resultado XML. El compilador emite una advertencia si no encuentra member
.
Comentarios
Compile con /doc
para procesar los comentarios de documentación a un archivo.
Para ver un ejemplo en el que se usa <see>
, consulte <summary>
.
El compilador de MSVC intentará resolver las referencias cref
en una pasada por los comentarios de documentación. Si el compilador no encuentra un símbolo al usar las reglas de búsqueda de C++, marca la referencia como no resuelta. Para obtener más información, vea <seealso>
.
Ejemplo
En el ejemplo siguiente se muestra cómo puede hacer que cref
haga referencia a un tipo genérico, de modo que el compilador resuelva la referencia.
// 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 {};