SuppressMessageAttribute Klasse

Definition

Namespace:

System.Diagnostics.CodeAnalysis

Assembly:

mscorlib.dll

Unterdrückt die Meldung einer bestimmten Codeanalyseregelverletzung, sodass mehrere Unterdrückungen für ein einzelnes Codeartefakt zugelassen werden. Gilt nicht für die Compilerdiagnose.

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

[<System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=true, Inherited=false)>]
[<System.Diagnostics.Conditional("CODE_ANALYSIS")>]
type SuppressMessageAttribute = class
    inherit Attribute

Public NotInheritable Class SuppressMessageAttribute
Inherits Attribute

Vererbung

Object

Attribute

SuppressMessageAttribute

Attribute

AttributeUsageAttribute ConditionalAttribute

Beispiele

Das folgende Codebeispiel zeigt die Verwendung des Attributs zum Unterdrücken von SuppressMessageAttribute Leistungswarnungen.

#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

Hinweise

Dieses Attribut kann auf ein beliebiges Anwendungselement angewendet werden. Eine vollständige Liste der Verletzungen, die unterdrückt werden können, finden Sie unter Codequalitätsregeln.

Note

Die ConditionalAttribute Klasse wird auf diese Klasse angewendet, wobei das Präverarbeitungssymbol "CODE_ANALYSIS" als bedingtes Symbol angegeben wird, das bestimmt, ob der Attributaufruf eingeschlossen oder ausgelassen wird. Wenn das Symbol definiert ist, wird der Attributaufruf eingeschlossen. andernfalls wird der Anruf weggelassen.

Wenn Sie in Visual Studio mit der rechten Maustaste auf eine Codeanalysewarnung klicken und Suppress <rule-ID>> in Der Unterdrückungsdatei auswählen oder Suppress <rule-ID>> in Source (Attribut), einer SuppressMessage Attribut wird entweder der globalen Unterdrückungsdatei oder der Quellcodedatei hinzugefügt. Weitere Informationen zum Attribut SuppressMessage und dessen Verwendung in Visual Studio finden Sie unter Suppress code analysis violations.

Konstruktoren

Name	Beschreibung
SuppressMessageAttribute(String, String)	Initialisiert eine neue Instanz der SuppressMessageAttribute Klasse, wobei die Kategorie des Codeanalysetools und der Bezeichner für eine Analyseregel angegeben wird.

Eigenschaften

Name	Beschreibung
Category	Ruft die Kategorie ab, die die Klassifizierung des Attributs identifiziert.
CheckId	Ruft den Bezeichner der Codeanalysetoolregel ab, die unterdrückt werden soll.
Justification	Dient zum Abrufen oder Festlegen der Begründung zum Unterdrücken der Codeanalysemeldung.
MessageId	Dient zum Abrufen oder Festlegen der erweiterten Ausschlusskriterien.
Scope	Dient zum Abrufen oder Festlegen des Bereichs des Codes, der für das Attribut relevant ist.
Target	Dient zum Abrufen oder Festlegen eines vollqualifizierten Pfads, der das Codeanalyseziel darstellt.
TypeId	Wenn sie in einer abgeleiteten Klasse implementiert wird, wird ein eindeutiger Bezeichner für diese Attribute. (Geerbt von Attribute)

Methoden

Name	Beschreibung
Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz einem angegebenen Objekt entspricht. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diesen instance zurück. (Geerbt von Attribute)
GetType()	Ruft die Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Wenn sie in einer abgeleiteten Klasse überschrieben wird, gibt an, ob der Wert dieser Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem angegebenen Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie der aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Explizite Schnittstellenimplementierungen

Name	Beschreibung
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu. (Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Ruft die Typinformationen für ein Objekt ab, mit denen die Typinformationen für eine Schnittstelle abgerufen werden können. (Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1). (Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Bietet Zugriff auf Eigenschaften und Methoden, die von einem Objekt verfügbar gemacht werden. (Geerbt von Attribute)