web-dev-qa-db-fra.com

Lien vers le site Web de la documentation XML C #

Est-il possible d'inclure un lien vers un site Web dans la documentation XML? Par exemple, ma méthode est résumée comme suit:

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

et quand je tape

SomeMathThing(

Je veux qu'IntelliSense affiche le résumé avec la possibilité de cliquer sur "ICI" pour créer un lien vers un site Web extérieur. Est-ce possible? Comment cela se ferait-il?

c#xmlhyperlink
116
john

Essayer:

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

Un peu tard dans le battage médiatique, mais voici ce que j'ai découvert pour Visual Studio 2015.

Mon échantillon ressemble à ceci:

    /// <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);
    }

Les résultats sont:

  1. Info-bulle:
    • Affiche cref-url avec!:, Mais masque "ceci"
    • Masque ahref-url mais affiche le texte
    • Masque l'URL et le texte de Seehref Screenshot of intellisense tooltip
  1. Explorateur d'objets:
    • Affiche cref-url avec!:, Mais cache "ceci" (non cliquable)
    • Masque ahref-url mais affiche le texte (non cliquable)
    • Masque l'URL et le texte de Seehref (non cliquable) Screenshot of ObjectBrowser
  1. ReSharper (CTRL + SHIFT + F1, commande ReSharper.ReSharper_QuickDoc)
    • Masque cref-url avec!:, Mais affiche "this" (non cliquable)
    • Interprète maintenant ahref-url (Version de 2016 et plus récente)
    • Masque l'URL et le texte de Seehref (non cliquable) Screenshot of Resharper QuickHelp

Conclusion: le meilleur, comme l'a souligné Heiner, serait

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

Mise à jour Comme l'a souligné Thomas Hagström, Resharper prend désormais en charge les URL a-href cliquables. Capture d'écran mise à jour en conséquence.

61
MHolzmayr

Vous pouvez inclure un préfixe!: Dans un cref pour le faire passer intact dans la documentation Xml générée afin que des outils tels que Document Innovasys! X et Sandcastle l'utilisent. par exemple.

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

Cependant, Visual Studio intellisense ne l'affichera pas comme un lien pour intellisense - ce ne serait pas très utile car c'est une info-bulle, vous ne pouvez donc pas cliquer dessus de toute façon.

18
fubaar

Vous pouvez utiliser la syntaxe HTML standard:

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

Le texte sera affiché dans Visual Studio.

18
Heiner