协慌网

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

最简单的方法是将ObsoleteAttribute作为属性添加到方法中 。确保包含适当的解释：

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

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

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

要通过警告标记为已废弃：

[Obsolete]
private static void SomeMethod()

使用时会收到警告：

并使用 IntelliSense：

如果你想要一条消息：

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

这是 IntelliSense 工具提示：

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

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

使用时，这是你得到的：

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

使用关键字Obsolete为方法添加注释。消息参数是可选的，但是一个好主意是传达为什么该项目现在已过时和 / 或使用什么。
例：

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