C# XML Documentación Enlace web

Question

¿Es posible incluir un enlace a un sitio web en la documentación XML? Por ejemplo, de mi método resumirse como

///<Summary> 
/// This is a math function I found HERE. 
///</Summary> 
public void SomeMathThing(Double[] doubleArray) 
{ 
    ... 
} 

y cuando escribo

SomeMathThing(

Quiero IntelliSense para mostrar el resumen con la opción de hacer clic en "aquí" para vincular a un sitio web externo. es posible? ¿Cómo se haría?

Answer 1

Probar:

///<Summary> 
/// This is a math function I found <see href="http://stackoverflow.com">HERE</see> 
///</Summary> 

Answer 2

Se puede incluir un: prefijo en un CREF tener que pasar a través de tocar en la documentación XML generado por lo que las herramientas tales como Innovasys Document! X y Castillo de arena van a usar. p.ej.

/// <summary> 
/// This is a math function I found <see cref="!:http://stackoverflow.com">HERE</see> 
/// </summary> 

Visual Studio IntelliSense no mostrará que como un enlace para intelisense sin embargo - no tendría mucho sentido, ya que es un texto de ayuda por lo que no puede hacer clic en él de todos modos.

Answer 3

Usted puede utilizar la sintaxis HTML estándar:

<a href="http://stackoverflow.com">here</a> 

El texto se mostrará en Visual Studio.

Answer 4

Un poco tarde en el bombo-tren, pero aquí es lo que he descubierto para Visual Studio 2015.

Mi ejemplo es el siguiente:

/// <summary> 
    ///  Retrieves information about the specified window. 
    ///  The function also retrieves the value at a specified offset into the extra window memory. 
    ///  From <see cref="!:https://msdn.microsoft.com/en-us/library/windows/desktop/ms633585(v=vs.85).aspx">this</see> MSDN-Link. 
    ///  AHref <a href="http://stackoverflow.com">here</a>. 
    ///  see-href <see href="http://stackoverflow.com">here</see>. 
    /// </summary> 
    /// <param name="hwnd"></param> 
    /// <param name="index"></param> 
    /// <returns> 
    ///  Testlink in return: <a href="http://stackoverflow.com">here</a> 
    /// </returns> 
    public static IntPtr GetWindowLongPtr(IntPtr hwnd, int index) 
    { 
     return IntPtr.Size == 4 ? GetWindowLongPtr32(hwnd, index) : GetWindowLongPtr64(hwnd, index); 
    } 

Los resultados son los siguientes:

1. Información sobre la herramienta:
   • Muestra CREF-u rl con:!, pero oculta "este"
   • Pieles ahref-url pero muestra el texto
   • Pieles seehref URL y el texto

---

navegador
2. objeto:
   • Muestra CREF-url con:!, pero oculta "este" (no haga clic capaz)
   • Oculta ahref-url, pero muestra el texto (no se puede hacer clic) URL y el texto (no se puede hacer clic)
   • Pieles seehref

---

3. ReSharper (CTRL + SHIFT + F1, Command ReSharper.ReSharper_QuickDoc)
   • Pieles CREF-url con:!, Pero muestra "este" (no se puede hacer clic)
   • hace ahora interpretar ahref-url (Versión de 2016 y posteriores) URL y el texto
   • Pieles seehref (no se puede hacer clic)

Conclusión: mejor, como Heiner señaló, habría

See <a href="link">this link</a> for more information. 

Actualización Como señaló Thomas Hagström, Resharper ahora admite URL a-href seleccionables. Captura de pantalla actualizada en consecuencia.