[FxCop.设计规则]13.定义自定义属性参数的访问属性

Define accessors for attribute arguments

Cause: In its constructor, an attribute defines arguments that do not have corresponding properties.

Rule Description

Attributes can define mandatory arguments that must be specified when applying the attribute to a target. These are sometimes called positional arguments because they are supplied to attribute constructors as positional parameters. For every mandatory argument, the attribute should also provide a corresponding read-only property so that the value of the argument can be retrieved at execution time. This rule checks to see that for each constructor parameter, you have defined the corresponding property.

Attributes can also define optional arguments, called named arguments. These arguments are supplied to attribute constructors by name and should have a corresponding read/write property.

For mandatory and optional arguments, the corresponding properties and constructor parameters should use the same name but different casing. (Properties use Pascal casing, and parameters use camel casing.)

How to Fix Violations

To fix a violation of this rule, add a read-only property for each constructor parameter that does not have one.

When to Exclude Messages

Exclude a message from this rule if you do not want the value of the mandatory argument to be retrievable.

Example Code

The following example shows two attributes that define a mandatory (positional) parameter. The first implementation of the attribute is incorrectly defined. The second implementation is correct.

[Visual Basic]

Imports System

Namespace DesignLibraryNamespace DesignLibrary

&＃39; Violates rule: DefineAccessorsForAttributeArguments.
<AttributeUsage(AttributeTargets.All)>  _
NotInheritable Public Class BadCustomAttributeClass BadCustomAttribute
    Inherits Attribute
    Private data As String
    
    &＃39; Missing the property that corresponds to 
    &＃39; the someStringData parameter.
    Public Sub New()Sub New(someStringData As String)
        data &＃61; someStringData
    End Sub &＃39;New
End Class &＃39;BadCustomAttribute



&＃39; Satisfies rule: Attributes should have accessors for all arguments.
<AttributeUsage(AttributeTargets.All)>  _
NotInheritable Public Class GoodCustomAttributeClass GoodCustomAttribute
    Inherits Attribute
    Private data As String
    
    Public Sub New()Sub New(someStringData As String)
        data &＃61; someStringData
    End Sub &＃39;New

    &＃39;The constructor parameter and property
    &＃39;name are the same except for case.
    
    Public ReadOnly Property SomeStringData()Property SomeStringData() As String
        Get
            Return data
        End Get
    End Property
End Class 

End Namespace

[C#]

using System;

namespace DesignLibrary
{
// Violates rule: DefineAccessorsForAttributeArguments.

   [AttributeUsage(AttributeTargets.All)]
   public sealed class BadCustomAttribute :Attribute 
   {
      string data;

      // Missing the property that corresponds to 
      // the someStringData parameter.

      public BadCustomAttribute(string someStringData)
      {
         data &＃61; someStringData;
      }
   }

// Satisfies rule: Attributes should have accessors for all arguments.

   [AttributeUsage(AttributeTargets.All)]
   public sealed class GoodCustomAttribute :Attribute 
   {
      string data;

      public GoodCustomAttribute(string someStringData)
      {
         data &＃61; someStringData;
      }
      //The constructor parameter and property
      //name are the same except for case.

      public string SomeStringData
      {
         get 
         {
            return data;
         }
      }
   }
}

Related Rules

Avoid unsealed attributes

See Also

Attribute Usage Guidelines