Compartir a través de

Aplicación de atributos

Use el siguiente proceso para aplicar un atributo a un elemento del código.

  1. Defina un nuevo atributo o use un atributo de .NET existente.

  2. Aplique el atributo al elemento de código colocándolo inmediatamente antes del elemento .

    Cada lenguaje tiene su propia sintaxis de atributo. En C++ y C#, el atributo está rodeado de corchetes y separado del elemento por un espacio en blanco, que puede incluir un salto de línea. En Visual Basic, el atributo está rodeado por corchetes angulares y debe estar en la misma línea lógica; el carácter de continuación de línea se puede usar si se desea un salto de línea.

  3. Especifique parámetros posicionales y parámetros con nombre para el atributo .

    Se requieren parámetros posicionales y deben aparecer antes de cualquier parámetro con nombre; corresponden a los parámetros de uno de los constructores del atributo. Los parámetros con nombre son opcionales y corresponden a las propiedades de lectura y escritura del atributo. En C++, y C#, especifique name=value para cada parámetro opcional, donde name es el nombre de la propiedad. En Visual Basic, especifique name:=value.

El atributo se emite en metadatos al compilar el código y está disponible para Common Language Runtime y cualquier herramienta o aplicación personalizada a través de los servicios de reflexión en tiempo de ejecución.

Por convención, todos los nombres de atributo terminan con "Attribute". Sin embargo, varios lenguajes que tienen como destino el entorno de ejecución, como Visual Basic y C#, no requieren que especifique el nombre completo de un atributo. Por ejemplo, si desea inicializar System.ObsoleteAttribute, solo debe hacer referencia a él como Obsoleto.

Aplicar un atributo a un método

En el ejemplo de código siguiente se muestra cómo usar System.ObsoleteAttribute, que marca el código como obsoleto. La cadena "Will be removed in next version" se pasa al atributo . Este atributo produce una advertencia del compilador que muestra la cadena pasada cuando se llama al código que describe el atributo.

public class Example
{
    // Specify attributes between square brackets in C#.
    // This attribute is applied only to the Add method.
    [Obsolete("Will be removed in next version.")]
    public static int Add(int a, int b)
    {
        return (a + b);
    }
}

class Test
{
    public static void Main()
    {
        // This generates a compile-time warning.
        int i = Example.Add(2, 2);
    }
}

Public Class Example
    ' Specify attributes between square brackets in C#.
    ' This attribute is applied only to the Add method.
    <Obsolete("Will be removed in next version.")>
    Public Shared Function Add(a As Integer, b As Integer) As Integer
        Return a + b
    End Function
End Class

Class Test
    Public Shared Sub Main()
        ' This generates a compile-time warning.
        Dim i As Integer = Example.Add(2, 2)
    End Sub
End Class

Aplicar atributos en el nivel de ensamblado

Si desea aplicar un atributo en el nivel de ensamblado, use la assembly palabra clave (Assembly en Visual Basic). El código siguiente muestra el AssemblyTitleAttribute aplicado en el nivel de ensamblado.

using System.Reflection;
[assembly:AssemblyTitle("My Assembly")]

Imports System.Reflection
<Assembly: AssemblyTitle("My Assembly")>

Cuando se aplica este atributo, la cadena "My Assembly" se coloca en el manifiesto del ensamblado en la parte de metadatos del archivo. Puede ver el atributo mediante el desensamblador de IL (Ildasm.exe) o mediante la creación de un programa personalizado para recuperar el atributo.

Consulte también