Sdílet prostřednictvím

Použití atributů

Pomocí následujícího procesu použijte atribut na prvek kódu.

  1. Definujte nový atribut nebo použijte existující atribut .NET.

  2. Použijte atribut na prvek kódu tak, že ho umístíte bezprostředně před prvek.

    Každý jazyk má vlastní syntaxi atributu. V jazyce C++ a C# je atribut ohraničen hranatými závorkami a oddělen od elementu prázdným znakem, který může obsahovat konec řádku. V jazyce Visual Basic je atribut obklopen úhlovými závorkami a musí být na stejné logické čáře; Znak pokračování řádku lze použít, pokud je požadovaný konec řádku.

  3. Zadejte poziční parametry a pojmenované parametry pro atribut.

    Poziční parametry jsou povinné a musí být před libovolnými pojmenovanými parametry; odpovídají parametrům jednoho z konstruktorů atributu. Pojmenované parametry jsou volitelné a odpovídají vlastnostem atributu pro čtení a zápis. V jazyce C++ a C# zadejte name=value pro každý volitelný parametr, kde name je název vlastnosti. V jazyce Visual Basic zadejte name:=value.

Atribut se emituje do metadat při kompilaci kódu a je k dispozici běhovému prostředí CLR (Common Language Runtime) a veškerému vlastnímu nástroji nebo aplikaci prostřednictvím služeb reflexe běhového prostředí.

Podle konvence končí všechny názvy atributů na "Attribute". Několik jazyků, které cílí na modul runtime, jako je Visual Basic a C#, však nevyžadují, abyste zadali úplný název atributu. Pokud například chcete inicializovat System.ObsoleteAttribute, stačí na ni odkazovat pouze jako zastaralé.

Aplikovat atribut na metodu

Následující příklad kódu ukazuje, jak použít System.ObsoleteAttribute, který označuje kód jako zastaralý. Řetězec "Will be removed in next version" se předá atributu. Tento atribut způsobí upozornění kompilátoru, které zobrazí předaný řetězec, když je volán kód, který atribut popisuje.

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

Použití atributů na úrovni sestavení

Pokud chcete použít atribut na úrovni sestavení, použijte assembly klíčové slovo (Assembly v jazyce Visual Basic). Následující kód znázorňuje AssemblyTitleAttribute aplikované na úrovni assembly.

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

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

Když je tento atribut aplikován, řetězec "My Assembly" se umístí do manifestu sestavení v části metadat souboru. Atribut můžete zobrazit buď pomocí nástroje IL Disassembler (Ildasm.exe), nebo vytvořením vlastního programu pro načtení atributu.

Viz také

  • Last updated on