Freigeben über

Anwenden von Attributen

  • Artikel

Verwenden Sie den folgenden Prozess, um ein Attribut auf ein Element Ihres Codes anzuwenden.

  1. Definieren Sie ein neues Attribut, oder verwenden Sie ein vorhandenes .NET-Attribut.

  2. Wenden Sie das Attribut auf das Codeelement an, indem Sie es unmittelbar vor dem Element platzieren.

    Jede Sprache verfügt über eine eigene Attributsyntax. In C++ und C# ist das Attribut von eckigen Klammern umgeben und durch Leerraum vom Element getrennt, wobei dieser Leerraum auch einen Zeilenumbruch enthalten kann. In Visual Basic ist das Attribut von spitzen Klammern umgeben und muss sich in derselben logischen Zeile befinden; das Zeilenfortsetzungszeichen kann verwendet werden, wenn ein Zeilenumbruch gewünscht ist.

  3. Geben Sie Positionsparameter und benannte Parameter für das Attribut an.

    Positionsparameter sind erforderlich und müssen vor benannten Parametern vorliegen; sie entsprechen den Parametern eines der Konstruktoren des Attributs. Benannte Parameter sind optional und entsprechen Lese-/Schreibeigenschaften des Attributs. Geben Sie in C++ und C# für jeden optionalen Parameter an name=value , wobei name es sich um den Namen der Eigenschaft handelt. Geben Sie in Visual Basic name:=value an.

Das Attribut wird in Metadaten ausgegeben, wenn Sie Ihren Code kompilieren und für die Common Language Runtime und alle benutzerdefinierten Tools oder Anwendungen über die Laufzeitreflektionsdienste verfügbar sind.

Standardmäßig enden alle Attributnamen mit "Attribut". Für mehrere Sprachen, die auf die Laufzeit abzielen, z. B. Visual Basic und C#, müssen Sie jedoch nicht den vollständigen Namen eines Attributs angeben. Wenn Sie System.ObsoleteAttribute initialisieren möchten (z. B. als Veraltet), müssen Sie nur darauf verweisen.

Anwenden eines Attributs auf eine Methode

Das folgende Codebeispiel zeigt, wie System.ObsoleteAttributeCode als veraltet markiert wird. Die Zeichenfolge "Will be removed in next version" wird an das Attribut übergeben. Dieses Attribut verursacht eine Compilerwarnung, die die übergebene Zeichenfolge anzeigt, wenn Code, den das Attribut beschreibt, aufgerufen wird.

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

Anwenden von Attributen auf Assemblyebene

Wenn Sie ein Attribut auf Assemblyebene anwenden möchten, verwenden Sie das assembly Schlüsselwort (Assembly in Visual Basic). Der folgende Code zeigt das auf Assemblyebene angewendete AssemblyTitleAttribute.

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

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

Wenn dieses Attribut angewendet wird, wird die Zeichenfolge "My Assembly" im Assemblymanifest im Metadatenteil der Datei platziert. Sie können das Attribut entweder mithilfe der IL Disassembler (Ildasm.exe) oder durch Erstellen eines benutzerdefinierten Programms zum Abrufen des Attributs anzeigen.

Siehe auch