ObsoleteAttribute 類別

定義

命名空間:

System

組件:

System.Runtime.dll

來源:

ObsoleteAttribute.cs

標記不再使用的程式項目。 此類別無法獲得繼承。

public ref class ObsoleteAttribute sealed : Attribute

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

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Constructor | System.AttributeTargets.Delegate | System.AttributeTargets.Enum | System.AttributeTargets.Event | System.AttributeTargets.Field | System.AttributeTargets.Interface | System.AttributeTargets.Method | System.AttributeTargets.Property | System.AttributeTargets.Struct, Inherited=false)>]
type ObsoleteAttribute = class
    inherit Attribute

Public NotInheritable Class ObsoleteAttribute
Inherits Attribute

繼承

Object

Attribute

ObsoleteAttribute

屬性

AttributeUsageAttribute

範例

下列範例會定義類別，其中包含屬性和以 ObsoleteAttribute 屬性標記的方法。 在程式代碼中存取 屬性的值 OldProperty 會產生編譯程式警告，但呼叫 CallOldMethod 方法會產生編譯程序錯誤。 此範例也會顯示當您嘗試編譯原始程式碼時所產生的輸出。

using System;
using System.Reflection;

public class Example
{
   // Mark OldProperty As Obsolete.
   [ObsoleteAttribute("This property is obsolete. Use NewProperty instead.", false)]
   public static string OldProperty
   { get { return "The old property value."; } }

   public static string NewProperty
   { get { return "The new property value."; } }

   // Mark CallOldMethod As Obsolete.
   [ObsoleteAttribute("This method is obsolete. Call CallNewMethod instead.", true)]
   public static string CallOldMethod()
   {
      return "You have called CallOldMethod.";
   }

   public static string CallNewMethod()
   {
      return "You have called CallNewMethod.";
   }

   public static void Main()
   {
      Console.WriteLine(OldProperty);
      Console.WriteLine();
      Console.WriteLine(CallOldMethod());
   }
}
// The attempt to compile this example produces output like the following output:
//    Example.cs(31,25): error CS0619: 'Example.CallOldMethod()' is obsolete:
//            'This method is obsolete. Call CallNewMethod instead.'
//    Example.cs(29,25): warning CS0618: 'Example.OldProperty' is obsolete:
//            'This property is obsolete. Use NewProperty instead.'

open System

// Mark oldValue As Obsolete.
[<ObsoleteAttribute("This value is obsolete. Use newValue instead.", false)>]
let oldValue =
    "The old property value."

let newValue =
    "The new property value."

// Mark callOldFunction As Obsolete.
[<ObsoleteAttribute("This function is obsolete. Call callNewFunction instead.", true)>]
let callOldFunction () =
    "You have called CallOldMethod."

let callNewFunction () =
    "You have called CallNewMethod."

printfn $"{oldValue}"
printfn ""
printfn $"{callOldFunction ()}"
// The attempt to compile this example produces output like the following output:
//    Example.fs(23,12): error FS0101: This construct is deprecated. This function is obsolete. Call callNewFunction instead.
//    Example.fs(21,12): warning FS0044: This construct is deprecated. This value is obsolete. Use newValue instead.

Imports System.Reflection

Public Module Example
   ' Mark OldProperty As Obsolete.
   <ObsoleteAttribute("This property is obsolete. Use NewProperty instead.", False)> 
   Public ReadOnly Property OldProperty As String
      Get
         Return "The old property value."
      End Get
   End Property
   
   Public ReadOnly Property NewProperty As String
      Get
         Return "The new property value."
      End Get
   End Property
   
   ' Mark OldMethod As Obsolete.
   <ObsoleteAttribute("This method is obsolete. Call CallNewMethod instead.", True)> 
   Public Function CallOldMethod() As String
      Return "You have called CallOldMethod."
   End Function
      
   Public Function CallNewMethod() As String   
      Return "You have called NewMethod."
   End Function   
   
   Public Sub Main()
      Console.WriteLine(OldProperty)
      Console.WriteLine()
      Console.WriteLine(CallOldMethod())
   End Sub  
End Module
'  The attempt to compile this example produces output like the following:
'    Example.vb(30) : warning BC40000: 'Public ReadOnly Property OldProperty As String' is obsolete: 
'                     'This property is obsolete. Use NewProperty instead.'.
'    
'          Console.WriteLine(OldProperty)
'                            ~~~~~~~~~~~
'    Example.vb(32) : error BC30668: 'Public Function CallOldMethod() As String' is obsolete: 
'                     'This method is obsolete. Call CallNewMethod instead.'.
'    
'          Console.WriteLine(CallOldMethod())
'                            ~~~~~~~~~~~~~

備註

ObsoleteAttribute 適用於所有程序專案，但元件、模組、參數和傳回值除外。 將項目標示為過時會通知使用者，未來產品版本中可能會移除元素。

指派給 屬性的 Message 字串會在程式代碼中使用屬性目標時，由編譯程序發出。 在理想情況下，字串應該提供一些因應措施或程序設計替代方案。

IsError使用 屬性向編譯程式指出是否應該使用 ObsoleteAttribute 屬性來發出錯誤， (IsErrortrue) 或 IsErrorfalse () 警告。

如需使用屬性的詳細資訊，請參閱 屬性。

建構函式

ObsoleteAttribute()	使用預設屬性，初始化 ObsoleteAttribute 類別的新執行個體。
ObsoleteAttribute(String)	使用指定的運算訊息來初始化 ObsoleteAttribute 類別的新執行個體。
ObsoleteAttribute(String, Boolean)	使用運算訊息和指示使用已過時項目是否視為錯誤的布林值 (Boolean)，來初始化 ObsoleteAttribute 類別的新執行個體。

屬性

DiagnosticId	取得或設定報告使用 API 時，編譯器所用的識別碼。
IsError	取得值，其指出編譯器是否會將使用過時的程式元素視為錯誤。
Message	取得因應措施訊息。
TypeId	在衍生類別中實作時，取得這個 Attribute 的唯一識別碼。 (繼承來源 Attribute)
UrlFormat	取得或設定相對應文件的 URL。 API 會接受格式字串而非實際 URL，並建立包含診斷識別碼的泛型 URL。

方法

Equals(Object)	傳回值，這個值指出此執行個體是否與指定的物件相等。 (繼承來源 Attribute)
GetHashCode()	傳回這個執行個體的雜湊碼。 (繼承來源 Attribute)
GetType()	取得目前執行個體的 Type。 (繼承來源 Object)
IsDefaultAttribute()	在衍生類別中覆寫時，表示這個執行個體的值是衍生類別的預設值。 (繼承來源 Attribute)
Match(Object)	在衍生類別中覆寫時，會傳回值，表示這個執行個體是否等於指定物件。 (繼承來源 Attribute)
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
ToString()	傳回代表目前物件的字串。 (繼承來源 Object)

另請參閱

• Attribute
• 使用屬性擴充中繼資料