CA1813: Evitar los atributos no sellados

Causa

Un tipo público hereda de System.Attribute, no es abstracto y no está sellado (NotInheritable en Visual Basic).

Descripción de la regla

.NET proporciona métodos para recuperar atributos personalizados. De forma predeterminada, estos métodos buscan la jerarquía de herencia de atributo. Por ejemplo, System.Attribute.GetCustomAttribute busca el tipo de atributo especificado o cualquier tipo de atributo que extienda el tipo de atributo especificado. La acción de sellar el atributo elimina la búsqueda en la jerarquía de herencia y puede mejorarse el rendimiento.

Cómo corregir infracciones

Para corregir una infracción de esta regla, selle el tipo de atributo o conviértalo en abstracto.

Cuándo suprimir las advertencias

Se puede suprimir una advertencia de esta regla. Suprímala solo si está definiendo una jerarquía de atributos y no puede sellar el atributo ni convertirlo en abstracto.

Supresión de una advertencia

Si solo quiere suprimir una única infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y volver a habilitar la regla.

#pragma warning disable CA1813
// The code that's violating the rule is on this line.
#pragma warning restore CA1813

Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad en none del archivo de configuración.

[*.{cs,vb}]
dotnet_diagnostic.CA1813.severity = none

Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.

Ejemplo

En el ejemplo siguiente se muestra un atributo personalizado que cumple esta regla.

// Satisfies rule: AvoidUnsealedAttributes.
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
public sealed class DeveloperAttribute : Attribute
{
    private string nameValue;
    public DeveloperAttribute(string name)
    {
        nameValue = name;
    }

    public string Name
    {
        get
        {
            return nameValue;
        }
    }
}

Imports System

Namespace ca1813

    ' Satisfies rule: AvoidUnsealedAttributes.
    <AttributeUsage(AttributeTargets.Class Or AttributeTargets.Struct)>
    Public NotInheritable Class DeveloperAttribute
        Inherits Attribute

        Public Sub New(name As String)
            Me.Name = name
        End Sub


        Public ReadOnly Property Name() As String
    End Class

End Namespace

Reglas relacionadas

• CA1019: Definir descriptores de acceso para los argumentos de atributo
• CA1018: Marcar atributos con AttributeUsageAttribute

Vea también

• Atributos