如何将方法标记为已过时或已弃用？

Question

如何使用C＃将方法标记为过时或弃用？

Answer 1

最短的方法是将ObsoleteAttribute添加为attribute to the method。请务必提供适当的解释：

[Obsolete("Method1 is deprecated, please use Method2 instead.")]
public void Method1()
{ … }

您还可以导致编译失败，将方法的用法视为 错误而不是警告 ，如果从像这样的代码中的某处调用该方法：

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

Answer 2

通过警告标记为过时：

[Obsolete]
private static void SomeMethod()

使用时会收到警告：

使用IntelliSense：

如果您想要留言：

[Obsolete("My message")]
private static void SomeMethod()

这是智能感知工具提示：

最后，如果您希望将用法标记为错误：

[Obsolete("My message", true)]
private static void SomeMethod()

使用时，这就是你得到的：

注意：使用该消息告诉人们应该使用什么，而不是为什么它已经过时。

Answer 3

使用关键字Obsolete为方法添加注释。消息参数是可选的，但是很好地交流为什么该项目现在已过时和/或使用什么 例如：

[System.Obsolete("use myMethodB instead")]
void myMethodA()

Answer 4

使用ObsoleteAttribute，您可以显示已弃用的方法。 过时的属性有三个构造函数：

  

  
1. [Obsolete]:是一个无参数构造函数，是使用此属性的默认值。
  以此格式
2. [Obsolete(string message)]:，您可以message了解不推荐使用此方法的原因。
  此格式消息中的
3. [Obsolete(string message, bool error)]:非常明确，但error表示编译时必须显示错误并导致编译失败。