Visual Studio 文档 XML 评论标签中的神秘 "usage" 标签
The Mysterious "usage" Tag in Visual Studio Documentation XML Comment Tags
我经常使用 XML 文档来记录我的 类、方法和属性，但看看 Microsoft 的这个方法：
用法?这是什么魔法？如何效仿这一魔法？
源码里没有这个，我查了（.Net 4.5）。它也没有 xmldoc 标记，它不应该存在，但它显示在工具提示中。
我不久前就注意到了，但没有时间去调查，所以现在我已经调查了，但我浪费了至少一个小时试图弄清楚它是徒劳的。
这是一件好事，因为它显示在工具提示中。我们确实有 <example> 标签，但事实并非如此，这是完全不同的东西。
我能找到的只有 <code> 元素，但它并没有像图片那样提供整洁的输出。
它似乎被硬编码为 Visual Studio 内部某处的 Task 静态方法：reference code and 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 评论。所以这提醒开发人员不要忘记等待 Tasks.
我经常使用 XML 文档来记录我的 类、方法和属性，但看看 Microsoft 的这个方法：
用法?这是什么魔法？如何效仿这一魔法？
源码里没有这个，我查了（.Net 4.5）。它也没有 xmldoc 标记，它不应该存在，但它显示在工具提示中。
我不久前就注意到了，但没有时间去调查，所以现在我已经调查了，但我浪费了至少一个小时试图弄清楚它是徒劳的。
这是一件好事，因为它显示在工具提示中。我们确实有 <example> 标签，但事实并非如此，这是完全不同的东西。
我能找到的只有 <code> 元素，但它并没有像图片那样提供整洁的输出。
它似乎被硬编码为 Visual Studio 内部某处的 Task 静态方法：reference code and 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 评论。所以这提醒开发人员不要忘记等待 Tasks.