天天看點
傳回

C# AttributeUsage

  • c# AttributeUsage的使用在我們開發中是十分常見的，那麼我們了解c# AttributeUsage的基本情況從何入手呢？那麼本文就向你詳細介紹相關的内容。

  • C# AttributeUsage的使用是如何的呢？首先讓我們來了解一下什麼是AttributeUsage類它是另外一個預定義特性類，AttributeUsage類的作用就是幫助我們控制定制特性的使用。其實AttributeUsage類就是描述了一個定制特性如和被使用。

    C# AttributeUsage的使用要明白：

    AttributeUsage有三個屬性，我們可以把它放置在定制屬性前面。第一個屬性是：

    ◆ValidOn 

    通過這個屬性，我們能夠定義定制特性應該在何種程式實體前放置。一個屬性可以被放置的所有程式實體在AttributeTargets enumerator中列出。通過OR操作我們可以把若幹個AttributeTargets值組合起來。

    ◆AllowMultiple 

    這個屬性标記了我們的定制特性能否被重複放置在同一個程式實體前多次。

    ◆Inherited 

    我們可以使用這個屬性來控制定制特性的繼承規則。它标記了我們的特性能否被繼承。

    C# AttributeUsage的使用執行個體：

    下面讓我們來做一些實際的東西。我們将會在剛才的Help特性前放置AttributeUsage特性以期待在它的幫助下控制Help特性的使用。

       
    1.  using System;          
      2.       
    2.  [AttributeUsage(AttributeTargets.Class), AllowMultiple = false,          
      3.       
    3.   Inherited = false ]          
      4.       
    4.  public class HelpAttribute : Attribute          
      5.       
    5.  {          
      6.       
    6.   public HelpAttribute(String Description_in)          
      7.       
    7.   {          
      8.       
    8.   this.description = Description_in;          
      9.       
    9.   }          
      10.       
    10.   protected String description;          
      11.       
    11.   public String Description          
      12.       
    12.   {          
      13.       
    13.   get          
      14.       
    14.   {          
      15.       
    15.   return this.description;          
      16.       
    16.   }          
      17.       
    17.   }          
      18.       
    18.  }        
      19.
    先讓我們來看一下AttributeTargets.Class。它規定了Help特性隻能被放在class的前面。這也就意味着下面的代碼将會産生錯誤：  
       
    1.  [Help("this is a do-nothing class")]          
      2.       
    2.  public class AnyClass          
      3.       
    3.  {          
      4.       
    4.   [Help("this is a do-nothing method")] //error          
      5.       
    5.   public void AnyMethod()          
      6.       
    6.   {          
      7.       
    7.   }          
      8.       
    8.  }        
      9.
    編譯器報告錯誤如下： 
       
    1.  AnyClass.cs: Attribute 'Help' is not valid on this declaration type.         
      2.           
    2.  It is valid on 'class' declarations only.         
      3.
    我們可以使用AttributeTargets.All來允許Help特性被放置在任何程式實體前。可能的值是： 
       
    1.  Assembly,          
      2.       
    2.  Module,          
      3.       
    3.  Class,          
      4.       
    4.  Struct,          
      5.       
    5.  Enum,          
      6.       
    6.  Constructor,          
      7.       
    7.  Method,          
      8.       
    8.  Property,          
      9.       
    9.  Field,          
      10.       
    10.  Event,          
      11.       
    11.  Interface,          
      12.       
    12.  Parameter,          
      13.       
    13.  Delegate,          
      14.       
    14.  All = Assembly | Module | Class |          
      15.       
    15.  Struct | Enum | Constructor |          
      16.       
    16.  Method | Property | Field | Event |          
      17.       
    17.  Interface | Parameter | Delegate,          
      18.       
    18.  ClassMembers = Class | Struct | Enum |         
      19.       
    19.   Constructor | Method | Property | Field |         
      20.       
    20.   Event | Delegate | Interface )        
      21.
    下面考慮一下AllowMultiple = false。它規定了特性不能被重複放置多次。 
       
    1.  [Help("this is a do-nothing class")]          
      2.       
    2.  [Help("it contains a do-nothing method")]          
      3.       
    3.  public class AnyClass          
      4.       
    4.  {          
      5.       
    5.   [Help("this is a do-nothing method")] //error          
      6.       
    6.   public void AnyMethod()          
      7.       
    7.   {          
      8.       
    8.   }          
      9.       
    9.  }         
      10.
    它産生了一個編譯期錯誤。  
       
    1.  AnyClass.cs: Duplicate 'Help' attribute        
      2.
    Ok,現在我們來讨論一下最後的這個屬性。Inherited, 表明當特性被放置在一個基類上時，它能否被派生類所繼承。 
       
    1.   [Help("BaseClass")]          
      2.       
    2.  public class Base          
      3.       
    3.  {          
      4.       
    4.  }          
      5.           
    5.  public class Derive : Base          
      6.       
    6.  {          
      7.       
    7.  }        
      8.
    C# AttributeUsage的使用會有四種可能的組合： 
       
    1.  [AttributeUsage(AttributeTargets.Class,         
      2.       
    2.   AllowMultiple = false, Inherited = false ]          
      3.       
    3.  [AttributeUsage(AttributeTargets.Class,          
      4.       
    4.  AllowMultiple = true, Inherited = false ]          
      5.       
    5.  [AttributeUsage(AttributeTargets.Class,          
      6.       
    6.  AllowMultiple = false, Inherited = true ]          
      7.       
    7.  [AttributeUsage(AttributeTargets.Class,          
      8.       
    8.  AllowMultiple = true, Inherited = true ]        
      9.

    C# AttributeUsage的使用第一種情況：

    如果我們查詢（Query）（稍後我們會看到如何在運作期查詢一個類的特性）Derive類，我們将會發現Help特性并不存在，因為inherited屬性被設定為false。

    C# AttributeUsage的使用第二種情況：

    和第一種情況相同，因為inherited也被設定為false。

    C# AttributeUsage的使用第三種情況：

    為了解釋第三種和第四種情況，我們先來給派生類添加點代碼： 

       
    1.  [Help("BaseClass")]          
      2.       
    2.  public class Base          
      3.       
    3.  {          
      4.       
    4.  }          
      5.       
    5.  [Help("DeriveClass")]          
      6.       
    6.  public class Derive : Base          
      7.       
    7.  {          
      8.       
    8.  }        
      9.

    現在我們來查詢一下Help特性，我們隻能得到派生類的屬性，因為inherited被設定為true，但是AllowMultiple卻被設定為false。是以基類的Help特性被派生類Help特性覆寫了。

    C# AttributeUsage的使用第四種情況：

    在這裡，我們将會發現派生類既有基類的Help特性，也有自己的Help特性，因為AllowMultiple被設定為true。

    C# AttributeUsage的相關内容就向你介紹到這裡，希望對你了解和掌握C# AttributeUsage的使用有所幫助。

c# constructor assembly interface class struct
上一篇: 為何和如何學習MarkDown為何和如何學習MarkDown
下一篇: markdown學習一、标題展示二、分割線三、字型樣式四、引用五、圖檔和超連結六、清單排序七、表格八、java代碼編寫

繼續閱讀