CA1019: Definir acessadores para argumentos de atributo

Causa

Em seu construtor, um atributo define argumentos que não possuem propriedades correspondentes.

Descrição da regra

Atributos podem definir argumentos obrigatórios que devem ser especificados quando você aplicar o atributo para um destino. Eles também são conhecidos como argumentos posicionais porque eles são fornecidos para construtores de atributo como parâmetros posicionais. Para cada argumento obrigatório, o atributo também deve fornecer uma propriedade correspondente de somente leitura para que o valor do argumento pode ser recuperado em tempo de execução. Esta regra verifica que, para cada parâmetro de construtor, você tenha definido a propriedade correspondente.

Atributos também podem definir argumentos opcionais, que também são conhecidos como argumentos nomeados. Esses argumentos são fornecidos para os construtores de atributo por nome e devem ter uma propriedade de leitura/gravação correspondente.

Para argumentos obrigatórios e opcionais, as propriedades correspondentes e os parâmetros do construtor devem usar o mesmo nome mas diferente de maiúsculas e minúsculas. Propriedades usar Pascal casing e capitalização de camel do uso de parâmetros.

Como corrigir violações

Para corrigir uma violação desta regra, adicione uma propriedade somente leitura para cada parâmetro de construtor que não tenha um.

Quando suprimir avisos

Elimina um aviso esta regra se não quiser que o valor do argumento obrigatório a ser recuperáveis.

Exemplo de atributos personalizados

Descrição

O exemplo a seguir mostra dois atributos que definem um parâmetro obrigatório de (Posicional). A primeira implementação do atributo está definida incorretamente. A segunda implementação está correta.

Código

Imports System

Namespace DesignLibrary

' Violates rule: DefineAccessorsForAttributeArguments.
<AttributeUsage(AttributeTargets.All)>  _
NotInheritable Public Class BadCustomAttribute
    Inherits Attribute
    Private data As String

    ' Missing the property that corresponds to 
    ' the someStringData parameter.
    Public Sub New(someStringData As String)
        data = someStringData
    End Sub 'New
End Class 'BadCustomAttribute

' Satisfies rule: Attributes should have accessors for all arguments.
<AttributeUsage(AttributeTargets.All)>  _
NotInheritable Public Class GoodCustomAttribute
    Inherits Attribute
    Private data As String

    Public Sub New(someStringData As String)
        data = someStringData
    End Sub 'New

    'The constructor parameter and property
    'name are the same except for case.

    Public ReadOnly Property SomeStringData() As String
        Get
            Return data
        End Get
    End Property
End Class 

End Namespace

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 = 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 = someStringData;
      }
      //The constructor parameter and property
      //name are the same except for case.

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

Argumentos posicionais e nomeados

Descrição

Argumentos posicionais e nomeados fazer para limpar a consumidores da sua biblioteca, quais argumentos são obrigatórios para o atributo e quais argumentos são opcionais.

O exemplo a seguir mostra uma implementação de um atributo que tem os argumentos posicionais e nomeados.

Código

using System; 

namespace DesignLibrary
{    
    [AttributeUsage(AttributeTargets.All)]        
    public sealed class GoodCustomAttribute : Attribute    
    {        
        string mandatory;        
        string optional;         

        public GoodCustomAttribute(string mandatoryData)        
        {            
            mandatory = mandatoryData;        
        }         

        public string MandatoryData        
        {            
            get { return mandatory; }        
        }         

        public string OptionalData        
        {            
            get { return optional; }            
            set { optional = value; }        
        }    
    }
}

Comentários

O exemplo a seguir mostra como aplicar o atributo personalizado para duas propriedades.

Código

[GoodCustomAttribute("ThisIsSomeMandatoryData", OptionalData = "ThisIsSomeOptionalData")]
public string MyProperty
{
    get { return myProperty; }
    set { myProperty = value; }
}

[GoodCustomAttribute("ThisIsSomeMoreMandatoryData")]
public string MyOtherProperty
{
    get { return myOtherProperty; }
    set { myOtherProperty = value; }
}

Regras relacionadas

CA1813: Evite atributos sem lacre

Consulte também

Referência

Diretrizes de uso do atributo