System.ObsoleteAttribute 类

方法描述

标记不再使用的程序元素。 此类不能被继承。

语法定义(C# System.ObsoleteAttribute 类 的用法)

[SerializableAttribute]
[ComVisibleAttribute(true)]
[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Constructor|AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Event|AttributeTargets.Interface|AttributeTargets.Delegate, Inherited = false)]
public sealed class ObsoleteAttribute : Attribute

构造函数

构造函数名称 构造函数描述
ObsoleteAttribute() 使用默认属性初始化 ObsoleteAttribute 类的新实例。
ObsoleteAttribute(String) 使用指定的变通方法消息初始化 ObsoleteAttribute 类的新实例。
ObsoleteAttribute(String, Boolean) 使用变通方法消息和布尔值初始化 ObsoleteAttribute 类的新实例，该布尔值指示是否将使用已过时的元素视为错误。

成员/方法

方法名称 方法描述
Equals 基础结构。返回一个值，该值指示此实例是否与指定的对象相等。 （继承自 Attribute。）
Finalize 允许对象在“垃圾回收”回收之前尝试释放资源并执行其他清理操作。 （继承自 Object。）
GetHashCode 返回此实例的哈希代码。 （继承自 Attribute。）
GetType 获取当前实例的 Type。 （继承自 Object。）
IsDefaultAttribute 当在派生类中重写时，指示此实例的值是否是派生类的默认值。 （继承自 Attribute。）
Match 当在派生类中重写时，返回一个指示此实例是否等于指定对象的值。 （继承自 Attribute。）
MemberwiseClone 创建当前 Object 的浅表副本。 （继承自 Object。）
ToString 返回表示当前对象的字符串。 （继承自 Object。）

提示和注释

ObsoleteAttribute 可适用于除程序集、模块、参数或返回值以外的所有程序元素。 将元素标记为过时可以通知用户：该元素在产品的未来版本中将被移除。

有关使用特性更多信息，请参见利用特性扩展元数据。

System.ObsoleteAttribute 类例子

任何尝试调用该方法的代码都将导致编译器发出警告。

using System;

public sealed class App {
   static void Main() {      
      // The line below causes the compiler to issue a warning:
      // 'App.SomeDeprecatedMethod()' is obsolete: 'Do not call this method.'
      SomeDeprecatedMethod();
   }

   // The method below is marked with the ObsoleteAttribute. 
   // Any code that attempts to call this method will get a warning.
   [Obsolete("Do not call this method.")]
   private static void SomeDeprecatedMethod() { }
}

继承层次结构

System.Object

System.Attribute

System.ObsoleteAttribute

命名空间

namespace: System

程序集: mscorlib（在 mscorlib.dll 中）

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。但不保证所有实例成员都是线程安全的。

版本信息

.NET Framework 受以下版本支持：4、3.5、3.0、2.0、1.1、1.0 .NET Framework Client Profile 受以下版本支持：4、3.5 SP1 受以下版本支持：

适用平台

Windows 7, Windows Vista SP1 或更高版本, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008（不支持服务器核心）, Windows Server 2008 R2（支持 SP1 或更高版本的服务器核心）, Windows Server 2003 SP2 .NET Framework 并不是对每个平台的所有版本都提供支持。有关支持的版本的列表，请参见.NET Framework 系统要求。

相关资源

System 命名空间
Attribute
利用特性扩展元数据
MSDN