我如何标记一个方法为过时或弃用使用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)]:在这种格式中,消息是非常显式的,但错误意味着,在编译时,编译器必须显示错误并导致编译失败。
推荐文章
- 函数应该返回空对象还是空对象?
- 如何转换日期时间?将日期时间
- 如何在c#中连接列表?
- 在c#中引用类型变量的“ref”的用途是什么?
- 防止在ASP中缓存。NET MVC中使用属性的特定操作
- 转换为值类型'Int32'失败,因为物化值为空
- c#中有任何连接字符串解析器吗?
- 在Linq中转换int到字符串到实体的问题
- 是否可以动态编译和执行c#代码片段?
- 创建自定义MSBuild任务时,如何从c#代码获取当前项目目录?
- MSBuild路径
- c#和Java的主要区别是什么?
- 在c#中创建一个特定时区的DateTime
- .NET中的属性是什么?
- csproj文件中的“Service Include”是干什么用的?