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
///<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 l'option de cliquer sur "ICI" pour créer un lien vers un site Web extérieur. Est-ce possible? Comment cela se ferait-il?
Un peu en retard dans le train hype, mais voici ce que j'ai découvert pour Visual Studio 2015.
Mon échantillon ressemble à ceci:
Les résultats sont:
Conclusion: le meilleur, comme l'a souligné Heiner, serait
Mise à jour Comme l'a souligné Thomas Hagström, Resharper prend désormais en charge les URL cliquables a-href. Capture d'écran mise à jour en conséquence.
la source
Vous pouvez utiliser la syntaxe HTML standard:
Le texte sera affiché dans Visual Studio.
la source
Vous pouvez inclure un préfixe!: Dans un cref pour qu'il soit passé intact dans la documentation Xml générée afin que des outils tels que Innovasys Document! X et Sandcastle l'utiliseront. par exemple
Visual Studio intellisense ne l'affichera pas comme un lien pour intellisense - ne serait pas très utile car il s'agit d'une info-bulle, vous ne pouvez donc pas cliquer dessus de toute façon.
la source
<see/>
URI de site Web cliquables et reconnus d'une manière ou d'une autre (puisque Object Browser n'est pas une info-bulle). Juste en disant ;-).Utilisez une balise. Par exemple j'ai utilisé cette solution dans mon projet
Le résultat est ici
Mon code xml est:
Ou utilisez la balise "voir". Le résultat est le même de la balise "a"
la source