valid - summary param name c#

C#XML Documentation Website Link

Question

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

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

y cuando escribo

SomeMathThing(

Quiero que IntelliSense muestre el resumen con la opción de hacer clic en "AQUÍ" para vincularlo a un sitio web externo. es posible? ¿Cómo se haría?

Answer 1

Puede incluir un prefijo!: En una cref para que pase sin ser tocado en la documentación Xml generada para que herramientas como el Documento Innovasys! X y Sandcastle lo usarán. p.ej

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

Sin embargo, Visual Studio intellisense no lo mostrará como un enlace para intellisense, no sería un gran punto, ya que es una información sobre herramientas, por lo que no puede hacer clic de todos modos.

Answer 2

Puede usar la sintaxis HTML estándar:

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

El texto se mostrará en Visual Studio.

Answer 3

Tratar:

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

Answer 4

Un poco tarde en el bombo, pero esto es lo que descubrí en Visual Studio 2015.

Mi muestra se ve así:

    /// <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://.com">here</a>.
    ///     see-href <see href="http://.com">here</see>.
    /// </summary>
    /// <param name="hwnd"></param>
    /// <param name="index"></param>
    /// <returns>
    ///     Testlink in return: <a href="http://.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:

1. Información sobre herramientas:
   • Muestra cref-url con!:, Pero oculta "esto"
   • Se esconde ahref-url pero muestra texto
   • Oculta la URL y el texto de seehref

2. Buscador de objetos:
   • Muestra cref-url con!:, Pero oculta "this" (no se puede hacer clic)
   • Oculta ahref-url pero muestra texto (no se puede hacer clic)
   • Oculta la URL y el texto de seehref (no se puede hacer clic)

3. ReSharper (CTRL + SHIFT + F1, comando ReSharper.ReSharper_QuickDoc)
   • Oculta cref-url con!:, Pero muestra "this" (no se puede hacer clic)
   • Ahora interpreta ahref-url (Versión de 2016 y más reciente)
   • Oculta la URL y el texto de seehref (no se puede hacer clic)

Conclusión: La mejor, como señaló Heiner, serí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 clicables. Captura de pantalla actualizada en consecuencia.