3

I XML-Dokumentation häufig verwenden, um meine Klassen, Methoden und Eigenschaften zu dokumentieren aber einen Blick auf diese Methode von Microsoft nehmen:The Mysterious "usage" Tag in Visual Studio-Dokumentation XML-Kommentar-Tags

enter image description here

Nutzungs? Was für eine Art von Zauberei ist das? Wie emuliert man diese Zauberei?

So etwas gibt es im Quellcode nicht, ich überprüfte (. Net 4.5). Es gibt auch kein xmldoc-Tag, es soll nicht existieren und wird trotzdem im Tooltip angezeigt.

Ich bemerkte es vor einer Weile, aber hatte keine Zeit zu untersuchen, also jetzt hatte ich und ich verschwendet mindestens eine Stunde vergeblich versuchen, es herauszufinden, vergebens.

Es ist eine nette Sache, weil es in Tooltips angezeigt wird. Wir haben das <example> Tag, aber das ist es nicht, das ist ein anderes Biest ganz.

Antwort

4

Alles, was ich finden kann, ist das <code> Element, aber es bietet keine so saubere Ausgabe als eine auf dem Bild.

Es sieht aus wie es in dem Visual Studio irgendwo Task statische Methoden fest einprogrammiert ist: reference code und github keine solche XML-Kommentare enthält, und ich habe keine andere Methoden mit solchen Usage Sache finden, auch die async diejenigen.

Vielleicht ist es ein Teil der Visual Studio-Unterstützung für async/await Syntax, Benachrichtigung des Entwicklers zu vergessen, die erstellte Aufgabe zu warten.

Update: Ich denke, das ist ein Visual Studio-Verhalten. Betrachten wir einen solchen Code:

public static Task<int> TestMethod1() 
{ 
    return Task.FromResult(9); 
} 

public static async Task<int> TestMethod2() 
{ 
    return await Task.FromResult(9); 
} 

Usage for TestMethod1

Usage for TestMethod2

Beide dieser Verfahren wird den Usage Abschnitt in Pop-up, ohne XML-Kommentare. So ist dies eine Erinnerung für Entwickler, nicht zu vergessen, die Task s zu erwarten.