ObsoleteAttribute Kelas

Definisi

Ruang nama:

System

Rakitan:

System.Runtime.dll

Sumber:

ObsoleteAttribute.cs

Menandai elemen program yang tidak lagi digunakan. Kelas ini tidak dapat diwariskan.

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

Warisan

Object

Attribute

ObsoleteAttribute

Atribut

AttributeUsageAttribute

Contoh

Contoh berikut mendefinisikan kelas yang berisi properti dan metode yang ditandai dengan ObsoleteAttribute atribut . Mengakses nilai OldProperty properti dalam kode menghasilkan peringatan pengkompilasi, tetapi memanggil CallOldMethod metode menghasilkan kesalahan pengkompilasi. Contohnya juga menunjukkan output yang dihasilkan saat Anda mencoba mengkompilasi kode sumber.

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())
'                            ~~~~~~~~~~~~~

Keterangan

ObsoleteAttribute berlaku untuk semua elemen program kecuali rakitan, modul, parameter, dan nilai pengembalian. Menandai elemen sebagai usang memberi tahu pengguna bahwa elemen dapat dihapus dalam versi produk yang akan datang.

String yang ditetapkan ke Message properti dipancarkan oleh pengkompilasi saat target atribut digunakan dalam kode. Idealnya, string harus memberikan beberapa solusi atau alternatif terprogram.

IsError Gunakan properti untuk menunjukkan kepada pengkompilasi apakah menggunakan ObsoleteAttribute atribut harus menyebabkannya memancarkan kesalahan (IsError adalah true) atau peringatan (IsError adalah false).

Untuk informasi selengkapnya tentang menggunakan atribut, lihat Atribut.

Konstruktor

ObsoleteAttribute()	Menginisialisasi instans ObsoleteAttribute baru kelas dengan properti default.
ObsoleteAttribute(String)	Menginisialisasi instans ObsoleteAttribute baru kelas dengan pesan solusi tertentu.
ObsoleteAttribute(String, Boolean)	Menginisialisasi instans ObsoleteAttribute baru kelas dengan pesan solusi sementara dan nilai Boolean yang menunjukkan apakah penggunaan elemen usang dianggap sebagai kesalahan.

Properti

DiagnosticId	Mendapatkan atau mengatur ID yang akan digunakan pengkompilasi saat melaporkan penggunaan API.
IsError	Mendapatkan nilai yang menunjukkan apakah pengkompilasi akan memperlakukan penggunaan elemen program usang sebagai kesalahan.
Message	Mendapatkan pesan solusi sementara.
TypeId	Ketika diimplementasikan di kelas turunan, mendapatkan pengidentifikasi unik untuk ini Attribute. (Diperoleh dari Attribute)
UrlFormat	Mendapatkan atau mengatur URL untuk dokumentasi terkait. API menerima string format alih-alih URL aktual, membuat URL generik yang menyertakan ID diagnostik.

Metode

Equals(Object)	Mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
GetHashCode()	Mengembalikan kode hash untuk instans ini. (Diperoleh dari Attribute)
GetType()	Mendapatkan dari instans Type saat ini. (Diperoleh dari Object)
IsDefaultAttribute()	Ketika ditimpa di kelas turunan, menunjukkan apakah nilai instans ini adalah nilai default untuk kelas turunan. (Diperoleh dari Attribute)
Match(Object)	Saat ditimpa di kelas turunan, mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
MemberwiseClone()	Membuat salinan dangkal dari saat ini Object. (Diperoleh dari Object)
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)

Lihat juga

• Attribute
• Memperluas metadata menggunakan atribut