神秘的“用法”标签在Visual Studio文档的XML注释标签

Question

我经常使用XML文档来记录我的类，方法和属性，但看看从微软这个方法：

用法？这是什么魔法？人们如何模仿这种巫术？

源代码中没有这样的东西，我检查（.Net 4.5）。也没有xmldoc标签，它不应该存在，但它显示在工具提示中。

我注意到了一段时间，但还没有时间去调查，所以现在我已经浪费了至少一小时的时间，试图找出它的结果。

这是一件好事，因为它出现在工具提示中。我们确实有<example>标签，但事实并非如此，这完全是一个不同的野兽。

Answer 1

我能找到的所有元素都是<code>，但它并不像图像那样提供如此整齐的输出。

它看起来像它的硬编码为Task静态方法在Visual Studio中的地方：reference code和github不包含这样的XML注释，我没有发现任何其他方法与此类Usage的事情，即使是async的。

也许它是Visual Studio支持async/await语法的一部分，通知开发人员不要忘记等待创建的任务。

更新：我认为这是一个Visual Studio行为。考虑这样的代码：

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

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

两个这样的方法会得到弹出Usage部分，没有任何XML注释。所以这是一个提醒开发者不要忘记等待Task s。