Visual Studio文档XML评论标签中的神秘“用法”标签

Question

我经常使用XML文档来记录我的类，方法和属性，但是请看一下Microsoft的这个方法：

用法？这是什么魔法？如何模仿这种魔法？

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

我曾经注意到它，但没有时间调查，所以现在我已经浪费了至少一个小时试图弄清楚它是徒劳的。

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

Answer 1

我所能找到的只是<code>元素，但它不能提供像图像那样整洁的输出。

看起来它在Visual Studio中的某个地方被Task静态方法硬编码：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。