【问题标题】:Automatically updating deprecated comment blocks in Visual Studio?自动更新 Visual Studio 中已弃用的注释块?
【发布时间】:2017-07-24 19:53:24
【问题描述】:

在visual studio中,如果你在函数上方按下///,它会自动创建一个函数头,如下所示:

/// <summary>
/// 
/// </summary>
/// <param name="arg1"></param>
/// <param name="arg2"></param>
void foo(int arg1, int arg2)
{

}

但假设我通过添加另一个参数来更新函数。有没有一种方法可以让我轻松更新 Visual Studio 或删除已弃用的?

或者一种将当前块添加到所有现有函数而不损坏“摘要”部分的方法?

【问题讨论】:

  • 添加新参数时有什么快速操作吗?
  • Resharper 会为你添加一个警告和一个快捷方式来解决这些问题,假设它还没有内置到 VS 中。

标签: c# documentation comments visual-studio-2017


【解决方案1】:

我建议您使用GhostDoc 扩展名。只需右键单击方法名称即可生成,很酷。

GhostDoc 是一个 Visual Studio 扩展,可根据方法和属性的类型、参数、名称和其他上下文信息自动生成 XML 文档 cmets。

希望对你有所帮助。 :)

【讨论】:

    【解决方案2】:

    如果你仍然需要这个答案,你应该检查另一个问题:How do I mark a method as Obsolete/Deprecated?

    [System.Obsolete("Method1 is deprecated, please use Method2 instead.")]
    

    【讨论】:

    • 这个问题是关于 XML cmets,而不是关于方法本身。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2012-03-04
    • 2015-02-28
    • 2012-05-30
    • 1970-01-01
    • 2017-10-09
    • 1970-01-01
    • 2019-10-24
    相关资源
    最近更新 更多