如何将方法标记为过期或已弃用?

如何使用C#将方法标记为过期或过期? 函数


#1楼

最简单的方法是将ObsoleteAttribute做为方法属性添加。 确保包括适当的解释: 工具

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

若是从下面的代码中调用该方法,您也可能致使编译失败,将方法的使用视为错误而不是警告spa

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

#2楼

使用关键字Obsolete向方法添加注释。 消息参数是可选的,可是一个很好的主意,用于传达为何如今该项目已过期和/或使用什么代替。
例: code

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

#3楼

用警告标记为过期: 图片

[Obsolete]
private static void SomeMethod()

使用时会收到警告: get

显示过期的警告

借助IntelliSense: 编译器

IntelliSense已过期的警告

若是您想留言: string

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

这是IntelliSense工具提示: io

IntelliSense显示过期的消息

最后,若是您但愿将用法标记为错误: 编译

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

使用后,您会获得:

方法使用状况显示为错误

注意:使用该消息告诉人们应该使用什么,而不是为何它已过期。


#4楼

使用ObsoleteAttribute您能够显示不同意使用的方法。 过期的属性具备三个构造函数:

  1. [Obsolete]:是无参数构造函数,而且是使用此属性的默认值。
  2. [Obsolete(string message)]:以这种格式,您能够得到有关不同意使用此方法的message
  3. [Obsolete(string message, bool error)]:此格式的消息很是明确,可是error表示在编译时,编译器必须显示错误,致使编译失败或失败。

在此处输入图片说明

相关文章
相关标签/搜索