我如何标记一个方法为过时或弃用使用c# ?


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

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

你也可以导致编译失败,将该方法的使用视为错误而不是警告,如果该方法是从如下代码中的某个地方调用的:

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

使用关键字Obsolete向方法添加注释。Message参数是可选的,但传达为什么该项现在已过时和/或使用什么代替是一个好主意。 例子:

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

用警告标记为过时:

[Obsolete]
private static void SomeMethod()

当你使用它时,你会得到一个警告:

智能感知:

如果你想留言:

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

下面是智能感知工具的提示:

最后,如果你想让这个用法被标记为错误:

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

当使用这是你得到的:

注意:使用消息来告诉人们他们应该用什么代替,而不是为什么它过时了。


使用ObsoleteAttribute,您可以将一个方法标记为已弃用。 它有三个构造函数:

[过时]:是一个无参数构造函数,是使用此属性的默认值。 [Obsolete(string message)]:在这种格式中,你可以得到这个方法被弃用的原因。 [过时(string message, bool error)]:在这种格式中,消息是非常显式的,但错误意味着,在编译时,编译器必须显示错误并导致编译失败。


对于依赖注入方法,将[Obsolete("description")]属性应用于声明而不是实现(:doh: moment For me)