.net - Visual Studio 文档 XML 注释标签中神秘的 "usage"标签

Question

我经常使用 XML 文档来记录我的类、方法和属性，但看看 Microsoft 的这个方法:

用法？这是什么魔法？如何效仿这一魔法？

源码里没有这个，我查了下(.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