SuppressMessageAttribute Class

Definition

Unterdrückt die Meldung eines bestimmten Verstoßes gegen eine statische Analysetoolregel und lässt mehrere Unterdrückungen in einem einzelnen Codeartefakt zu.Suppresses reporting of a specific static analysis tool rule violation, allowing multiple suppressions on a single code artifact. Dies gilt nicht für die Compilerdiagnose.Does not apply to compiler diagnostics.

public ref class SuppressMessageAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=true, Inherited=false)]
[System.Diagnostics.Conditional("CODE_ANALYSIS")]
public sealed class SuppressMessageAttribute : Attribute
type SuppressMessageAttribute = class
    inherit Attribute
Public NotInheritable Class SuppressMessageAttribute
Inherits Attribute
Inheritance
SuppressMessageAttribute
Attributes

Examples

Das folgende Codebeispiel zeigt die Verwendung des SuppressMessageAttribute-Attributs, um Leistungs Warnmeldungen zu unterdrücken.The following code example shows the use of the SuppressMessageAttribute attribute to suppress performance warning messages.

#define CODE_ANALYSIS
using System;
using System.Diagnostics.CodeAnalysis;

namespace CodeAnalysisSample
{
    class Library
    {
        [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "isChecked")]
        [SuppressMessage("Microsoft.Performance", "CA1804:RemoveUnusedLocals", MessageId = "fileIdentifier")]
        static void FileNode(string name, bool isChecked)
        {
            string fileIdentifier = name;
            string fileName = name;
            string version = String.Empty;
        }
    }
}
#Const CODE_ANALYSIS = True
Imports System.Diagnostics.CodeAnalysis



Class Library
    
    <SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId:="isChecked"), _
     SuppressMessage("Microsoft.Performance", "CA1804:RemoveUnusedLocals", MessageId:="fileIdentifier")> _
    Shared Sub FileNode(ByVal name As String, ByVal isChecked As Boolean)
        Dim fileIdentifier As String = name
        Dim fileName As String = name
        Dim version As String = String.Empty

    End Sub
End Class

Remarks

Dieses Attribut kann auf ein beliebiges Anwendungs Element angewendet werden.This attribute can be applied to any application element. Eine umfassende Liste der Verstöße, die unterdrückt werden können, finden Sie unter Code Analyse für Warnungen in verwaltetem Code.For a complete list of the violations that can be suppressed, see Code Analysis for Managed Code Warnings.

Note

Der ConditionalAttribute wird auf diese Klasse angewendet und gibt das Vorverarbeitungs Symbol "CODE_ANALYSIS" als bedingtes Symbol an, das bestimmt, ob der Attribut Aufrufwert eingeschlossen oder ausgelassen wird.The ConditionalAttribute is applied to this class, specifying the preprocessing symbol "CODE_ANALYSIS" as the conditional symbol that determines whether the attribute call is included or omitted. Wenn das Symbol definiert ist, ist der Attribut Aufrufwert enthalten. Andernfalls wird der-Befehl ausgelassen.If the symbol is defined, the attribute call is included; otherwise, the call is omitted.

Wenn Sie in der Visual Studio- Fehlerliste mit der rechten Maustaste auf eine Code Analyse Warnung klicken und dann auf nach richten unterdrückenklicken, wird entweder im Code oder in der globalen Unterdrückungsdatei des Projekts ein SuppressMessage -Attribut hinzugefügt.When you right-click a Code Analysis warning in the Visual Studio Error List and then click Suppress Message(s), a SuppressMessage attribute is added either in your code or to the project's global suppressions file. Weitere Informationen zum SuppressMessage -Attribut und dessen Verwendung in Visual Studio finden Sie unter in der Quellen Unterdrückungs Übersicht.For more information about the SuppressMessage attribute and its use in Visual Studio, see In Source Suppression Overview.

Constructors

SuppressMessageAttribute(String, String)

Initialisiert eine neue Instanz der SuppressMessageAttribute-Klasse und gibt die Kategorie des statischen Analysetools und den Bezeichner für eine Analyseregel an.Initializes a new instance of the SuppressMessageAttribute class, specifying the category of the static analysis tool and the identifier for an analysis rule.

Properties

Category

Ruft die Kategorie ab, die die Klassifizierung des Attributs bezeichnet.Gets the category identifying the classification of the attribute.

CheckId

Ruft den Bezeichner der statischen Analysetoolregel ab, die unterdrückt werden soll.Gets the identifier of the static analysis tool rule to be suppressed.

Justification

Ruft die Begründung für das Unterdrücken der Codeanalysemeldung ab oder legt diese fest.Gets or sets the justification for suppressing the code analysis message.

MessageId

Ruft ein optionales Argument ab, das Ausschlusskriterien erweitert, oder legt dieses fest.Gets or sets an optional argument expanding on exclusion criteria.

Scope

Ruft den Bereich des Codes ab, der für das Attribut relevant ist, oder legt diesen fest.Gets or sets the scope of the code that is relevant for the attribute.

Target

Ruft einen voll qualifizierten Pfad ab, der das Ziel des Attributs darstellt, oder legt diesen fest.Gets or sets a fully qualified path that represents the target of the attribute.

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Inherited from Attribute)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to