Ist es möglich, einen Link zu einer Website in die XML-Dokumentation aufzunehmen? Zum Beispiel ist meine Methode zusammengefasst als
///<Summary>
/// This is a math function I found HERE.
///</Summary>
public void SomeMathThing(Double[] doubleArray)
{
...
}
und wenn ich tippe
SomeMathThing(
Ich möchte, dass IntelliSense die Zusammenfassung mit der Option anzeigt, auf "HIER" zu klicken, um auf eine externe Website zu verlinken. Ist das möglich? Wie würde es gemacht werden?
href
Attribut.Ein bisschen spät im Hype-Zug, aber hier ist, was ich für Visual Studio 2015 herausgefunden habe.
Mein Beispiel sieht so aus:
Die Ergebnisse sind:
Fazit: Das Beste, wie Heiner betonte, wäre
Update Wie Thomas Hagström betonte, unterstützt Resharper jetzt anklickbare a-href-URLs. Screenshot entsprechend aktualisiert.
quelle
Sie können die Standard-HTML-Syntax verwenden:
Der Text wird in Visual Studio angezeigt.
quelle
Sie können ein!: Präfix in eine cref einfügen, damit es in der generierten XML-Dokumentation unberührt bleibt, sodass Tools wie Innovasys Document! X und Sandcastle werden es benutzen. z.B
Visual Studio Intellisense zeigt dies jedoch nicht als Link für Intellisense an - wäre nicht sehr sinnvoll, da es sich um einen Tooltip handelt, sodass Sie ohnehin nicht darauf klicken können.
quelle
<see/>
aufklickbare und erkannte Website-URIs erstellt hätte (da der Objektbrowser kein Tooltip ist). Ich sag bloß' ;-).Verwenden Sie ein Tag. Zum Beispiel habe ich diese Lösung in meinem Projekt verwendet
Ergebnis ist hier
Mein XML-Code lautet:
Oder verwenden Sie das Tag "see". Das Ergebnis ist dasselbe wie bei einem "a" -Tag
quelle