【问题标题】:The Mysterious "usage" Tag in Visual Studio Documentation XML Comment TagsVisual Studio 文档 XML 注释标签中的神秘“用法”标签
【发布时间】:2018-03-24 07:54:14
【问题描述】:

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

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

源代码中没有这样的东西,我检查了(.Net 4.5)。它也没有 xmldoc 标记,它不应该存在,但它显示在工具提示中。

我不久前注意到了它,但还没有时间调查,所以现在我有,而且我浪费了至少一个小时试图弄清楚它是徒劳的。

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

【问题讨论】:

    标签: .net visual-studio task-parallel-library .net-4.5 xml-documentation


    【解决方案1】:

    我能找到的只有 <code> 元素,但它没有提供像图片中那样整洁的输出。

    看起来它在 Visual Studio 中的某处被硬编码为 Task 静态方法:reference codegithub 不包含此类 xml cmets,而且我没有找到具有此类 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 cmets。所以这提醒开发者不要忘记等待Tasks。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2012-06-17
      • 1970-01-01
      • 1970-01-01
      • 2020-02-06
      • 2020-10-10
      • 1970-01-01
      • 2015-08-25
      • 2013-06-13
      相关资源
      最近更新 更多